termreader.h File Reference

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

Go to the source code of this file.

Defines
#define	CHECK_LEAKS()
Typedefs
typedef TermReaderStruct	TermReader
typedef ICLTerm *(*)	TermReaderGetNext (TermReader *, double)
typedef void(*)	TermReaderCleanup (TermReader *)
typedef enum TermReaderTypeEnum	TermReaderType
Enumerations
enum	TermReaderTypeEnum { UNKNOWNTERMREADERTYPE = -1, STRINGTERMREADERTYPE = 0, BINARYTERMREADERTYPE = 1, FILETERMREADERTYPE = 2 }
enum	TermReaderErrorNum {   TERMREADER_BINUNREACHABLE = -106, TERMREADER_BINNOTENOUGHARGS = -105, TERMREADER_BINBADICLSTRUCT = -104, TERMREADER_BINBADICLSTR = -103,   TERMREADER_BINBADICLVAR = -102, TERMREADER_BINUNEXPECTEDTYPE = -101, TERMREADER_BINUNEXPECTEDSENTINEL = -100, TERMREADER_NOTINITIALIZED = -3,   TERMREADER_READERR = -2, TERMREADER_SELECTERR = -1, TERMREADER_OKAY = 0, TERMREADER_TIMEOUT = 1,   TERMREADER_NOCONN = 2, TERMREADER_EOF = 3, TERMREADER_BINNOTENOUGHDATA = 100 }
Functions
EXTERN TermReader *	termReader_create ()
EXTERN void	termReader_free (TermReader *t)
EXTERN void	termReader_setError (TermReader *t, gint errnum)
EXTERN gint	termReader_getError (TermReader *t)
EXTERN void	termReader_setSocket (TermReader *t, gint newsocket)
EXTERN gint	termReader_getSocket (TermReader *t)
EXTERN void	termReader_setType (TermReader *t, TermReaderType type)
EXTERN TermReaderType	termReader_getType (TermReader *t)
EXTERN void	termReader_setReaderSpecificData (TermReader *t, gpointer g)
EXTERN gpointer	termReader_getReaderSpecificData (TermReader *t)
EXTERN void	termReader_setGetNextCallback (TermReader *t, TermReaderGetNext g)
EXTERN void	termReader_setCleanupCallback (TermReader *t, TermReaderCleanup c)
EXTERN ICLTerm *	termReader_getNextTerm (TermReader *t, double timeout)
	Returns NULL on error--check TermReader.error.

---

Detailed Description

Definition in file termreader.h.

---

Define Documentation

 

#define CHECK_LEAKS

(

)

Definition at line 34 of file termreader.h.

---

Typedef Documentation

typedef struct TermReaderStruct TermReader

Definition at line 42 of file termreader.h.

typedef void(*) TermReaderCleanup(TermReader *)

Definition at line 45 of file termreader.h.

typedef ICLTerm*(*) TermReaderGetNext(TermReader *, double)

Definition at line 44 of file termreader.h.

typedef enum TermReaderTypeEnum TermReaderType

Definition at line 54 of file termreader.h.

---

Enumeration Type Documentation

enum TermReaderErrorNum

Enumerator:

TERMREADER_BINUNREACHABLE
TERMREADER_BINNOTENOUGHARGS
TERMREADER_BINBADICLSTRUCT
TERMREADER_BINBADICLSTR
TERMREADER_BINBADICLVAR
TERMREADER_BINUNEXPECTEDTYPE
TERMREADER_BINUNEXPECTEDSENTINEL
TERMREADER_NOTINITIALIZED
TERMREADER_READERR
TERMREADER_SELECTERR
TERMREADER_OKAY
TERMREADER_TIMEOUT
TERMREADER_NOCONN
TERMREADER_EOF
TERMREADER_BINNOTENOUGHDATA

Definition at line 56 of file termreader.h.

enum TermReaderTypeEnum

Enumerator:

UNKNOWNTERMREADERTYPE
STRINGTERMREADERTYPE
BINARYTERMREADERTYPE
FILETERMREADERTYPE

Definition at line 47 of file termreader.h.

---

Function Documentation

EXTERN TermReader* termReader_create

(

)

Definition at line 39 of file termreader.c.

EXTERN void termReader_free

(

TermReader *

t

)

Definition at line 51 of file termreader.c.

EXTERN gint termReader_getError

(

TermReader *

t

)

Definition at line 75 of file termreader.c.

EXTERN ICLTerm* termReader_getNextTerm	(	TermReader *	t,
		double	timeout
	)

Returns NULL on error--check TermReader.error.

Definition at line 59 of file termreader.c.

EXTERN gpointer termReader_getReaderSpecificData

(

TermReader *

t

)

Definition at line 105 of file termreader.c.

EXTERN gint termReader_getSocket

(

TermReader *

t

)

Definition at line 85 of file termreader.c.

EXTERN TermReaderType termReader_getType

(

TermReader *

t

)

Definition at line 95 of file termreader.c.

EXTERN void termReader_setCleanupCallback	(	TermReader *	t,
		TermReaderCleanup	c
	)

Definition at line 115 of file termreader.c.

EXTERN void termReader_setError	(	TermReader *	t,
		gint	errnum
	)

Definition at line 70 of file termreader.c.

EXTERN void termReader_setGetNextCallback	(	TermReader *	t,
		TermReaderGetNext	g
	)

Definition at line 110 of file termreader.c.

EXTERN void termReader_setReaderSpecificData	(	TermReader *	t,
		gpointer	g
	)

Definition at line 100 of file termreader.c.

EXTERN void termReader_setSocket	(	TermReader *	t,
		gint	newsocket
	)

Definition at line 80 of file termreader.c.

EXTERN void termReader_setType	(	TermReader *	t,
		TermReaderType	type
	)

Definition at line 90 of file termreader.c.

---