termsender.h File Reference

#include "libicl.h"
#include "glib.h"

Go to the source code of this file.

Typedefs
typedef TermSenderStruct	TermSender
typedef void(*)	TermSenderSendTerm (TermSender *, ICLTerm *)
typedef void(*)	TermSenderCleanup (TermSender *)
typedef enum TermSenderTypeEnum	TermSenderType
Enumerations
enum	TermSenderTypeEnum { UNKNOWNTERMSENDERTYPE = -1, STRINGTERMSENDERTYPE = 0, BINARYTERMSENDERTYPE = 1 }
enum	TermSenderErrorNum {   TERMSENDER_BININVALIDELEMENT = -102, TERMSENDER_BINUNKNOWNTYPETWICE = -101, TERMSENDER_BINUNKNOWNTYPEONCE = -100, TERMSENDER_BADTRANSLATION = -4,   TERMSENDER_NOTINITIALIZED = -3, TERMSENDER_BADSEND = -2, TERMSENDER_NULLTOSEND = -1, TERMSENDER_OKAY = 0 }
Functions
EXTERN TermSender *	termSender_create ()
EXTERN void	termSender_free (TermSender *t)
EXTERN int	termSender_sendTerm (TermSender *sender, ICLTerm *term)
	Return -1 on error--check sender.error.
EXTERN void	termSender_setError (TermSender *t, gint errnum)
EXTERN gint	termSender_getError (TermSender *t)
EXTERN void	termSender_setSocket (TermSender *t, gint newsocket)
EXTERN gint	termSender_getSocket (TermSender *t)
EXTERN void	termSender_setType (TermSender *t, TermSenderType type)
EXTERN TermSenderType	termSender_getType (TermSender *t)
EXTERN void	termSender_setSenderSpecificData (TermSender *t, gpointer g)
EXTERN gpointer	termSender_getSenderSpecificData (TermSender *t)
EXTERN void	termSender_setSendTermCallback (TermSender *t, TermSenderSendTerm s)
EXTERN void	termSender_setCleanupCallback (TermSender *t, TermSenderCleanup c)

---

Detailed Description

Definition in file termsender.h.

---

Typedef Documentation

typedef struct TermSenderStruct TermSender

Definition at line 32 of file termsender.h.

typedef void(*) TermSenderCleanup(TermSender *)

Definition at line 35 of file termsender.h.

typedef void(*) TermSenderSendTerm(TermSender *, ICLTerm *)

Definition at line 34 of file termsender.h.

typedef enum TermSenderTypeEnum TermSenderType

Definition at line 43 of file termsender.h.

---

Enumeration Type Documentation

enum TermSenderErrorNum

Enumerator:

TERMSENDER_BININVALIDELEMENT
TERMSENDER_BINUNKNOWNTYPETWICE
TERMSENDER_BINUNKNOWNTYPEONCE
TERMSENDER_BADTRANSLATION
TERMSENDER_NOTINITIALIZED
TERMSENDER_BADSEND
TERMSENDER_NULLTOSEND
TERMSENDER_OKAY

Definition at line 45 of file termsender.h.

enum TermSenderTypeEnum

Enumerator:

UNKNOWNTERMSENDERTYPE
STRINGTERMSENDERTYPE
BINARYTERMSENDERTYPE

Definition at line 37 of file termsender.h.

---

Function Documentation

EXTERN TermSender* termSender_create

(

)

Definition at line 35 of file termsender.c.

EXTERN void termSender_free

(

TermSender *

t

)

Definition at line 47 of file termsender.c.

EXTERN gint termSender_getError

(

TermSender *

t

)

Definition at line 75 of file termsender.c.

EXTERN gpointer termSender_getSenderSpecificData

(

TermSender *

t

)

Definition at line 105 of file termsender.c.

EXTERN gint termSender_getSocket

(

TermSender *

t

)

Definition at line 85 of file termsender.c.

EXTERN TermSenderType termSender_getType

(

TermSender *

t

)

Definition at line 95 of file termsender.c.

EXTERN int termSender_sendTerm	(	TermSender *	sender,
		ICLTerm *	term
	)

Return -1 on error--check sender.error.

Definition at line 55 of file termsender.c.

EXTERN void termSender_setCleanupCallback	(	TermSender *	t,
		TermSenderCleanup	c
	)

Definition at line 115 of file termsender.c.

EXTERN void termSender_setError	(	TermSender *	t,
		gint	errnum
	)

Definition at line 70 of file termsender.c.

EXTERN void termSender_setSenderSpecificData	(	TermSender *	t,
		gpointer	g
	)

Definition at line 100 of file termsender.c.

EXTERN void termSender_setSendTermCallback	(	TermSender *	t,
		TermSenderSendTerm	s
	)

Definition at line 110 of file termsender.c.

EXTERN void termSender_setSocket	(	TermSender *	t,
		gint	newsocket
	)

Definition at line 80 of file termsender.c.

EXTERN void termSender_setType	(	TermSender *	t,
		TermSenderType	type
	)

Definition at line 90 of file termsender.c.

---