nhproxy_io_func ()

int         (*nhproxy_io_func)              (nhproxy_genericptr_t handle,
                                             nhproxy_genericptr_t buf,
                                             unsigned int len);

NHPROXY_IO_RDONLY

#define NHPROXY_IO_RDONLY		1

NHPROXY_IO_WRONLY

#define NHPROXY_IO_WRONLY		2

NHPROXY_IO_NBLOCK

#define NHPROXY_IO_NBLOCK		4

NHPROXY_IO_NOAUTOFILL

#define NHPROXY_IO_NOAUTOFILL	8

NHPROXY_IO_LINEBUF

#define NHPROXY_IO_LINEBUF	16	/* Only honoured by text based calls */

NHPROXY_IO_SIMPLEBUFFER

#define NHPROXY_IO_SIMPLEBUFFER	32

NHPROXY_IO_PENDING

#define NHPROXY_IO_PENDING	64

nhproxy_io_open ()

NhProxyIO*  nhproxy_io_open                 (nhproxy_io_func func,
                                             nhproxy_genericptr_t handle,
                                             unsigned int flags);

nhproxy_io_close ()

nhproxy_bool_t nhproxy_io_close             (NhProxyIO *io);

nhproxy_io_getmode ()

unsigned int nhproxy_io_getmode             (NhProxyIO *io);

nhproxy_io_setmode ()

void        nhproxy_io_setmode              (NhProxyIO *io,
                                             unsigned int flags);

nhproxy_io_setautofill_limit ()

void        nhproxy_io_setautofill_limit    (NhProxyIO *io,
                                             unsigned int limit);

nhproxy_io_setnbfunc ()

void        nhproxy_io_setnbfunc            (NhProxyIO *io,
                                             nhproxy_io_func func);

nhproxy_io_filbuf ()

int         nhproxy_io_filbuf               (NhProxyIO *io,
                                             nhproxy_bool_t blocking);

nhproxy_io_getc ()

int         nhproxy_io_getc                 (NhProxyIO *io);

nhproxy_io_read ()

int         nhproxy_io_read                 (NhProxyIO *io,
                                             char *buf,
                                             int nb);

reads between 1 and nb bytes from the stream. A read will only be requested on the underlying I/O system if there would otherwise be no bytes to return to the caller (and not even then if NHPROXY_IO_NOAUTOFILL is set). This prevents blocking but means that using nhproxy_io_read() to read fixed sized datums is not useful. For example,

nhproxy_io_read(io, &datum, sizeof(datum));

may easily only partially read datum even though the rest of datum is available for reading. Where the caller knows in advance that an infinite block will not occur when reading, nhproxy_io_fread() should be used instead:

nhproxy_io_fread(&datum, sizeof(datum), 1, io);

nhproxy_io_fread ()

int         nhproxy_io_fread                (nhproxy_genericptr_t buffer,
                                             int size,
                                             int nmemb,
                                             NhProxyIO *io);

reads up to nmemb members of the given size and returns the number read. Where fewer members were read than requested then an EOF or ERROR has occured. Any partially read member will still be available for reading after nhproxy_io_fread() returns.

nhproxy_io_getpacket ()

char*       nhproxy_io_getpacket            (NhProxyIO *io,
                                             int *nb);

gets the last packet read under certain circumstances. This will always work if the caller sets no-autofill mode and calls nhproxy_io_fillbuf() on an empty buffer. Calls to nhproxy_io_fread() must also be avoided since this can cause simple buffer mode to be cancelled (nhproxy_io_fread() could be re-written to avoid this if it became important).

nhproxy_io_willblock ()

int         nhproxy_io_willblock            (NhProxyIO *io);

nhproxy_io_flush ()

nhproxy_bool_t nhproxy_io_flush             (NhProxyIO *io);

nhproxy_io_fputc ()

int         nhproxy_io_fputc                (int c,
                                             NhProxyIO *io);

nhproxy_io_write ()

int         nhproxy_io_write                (NhProxyIO *io,
                                             char *buf,
                                             int nb);

nhproxy_io_writet ()

int         nhproxy_io_writet               (NhProxyIO *io,
                                             char *buf,
                                             int nb);

nhproxy_io_vprintf ()

int         nhproxy_io_vprintf              (NhProxyIO *io,
                                             char *fmt,
                                             va_list ap);

nhproxy_io_printf ()

int         nhproxy_io_printf               (NhProxyIO *io,
                                             char *fmt,
                                             ...);