iob_send(3) [debian man page]

iob_send(3)						     Library Functions Manual						       iob_send(3)

NAME

       iob_send - send I/O batch

SYNTAX

       #include <iob.h>

       int64 iob_send(int64 s,io_batch* b);

DESCRIPTION

       iob_send sends the (rest of) b over the socket s.

       iob_send  returns  the number of bytes written, 0 if there were no more bytes to be written in the batch, -1 for EAGAIN, or -3 for a perma-
       nent error (for example "connection reset by peer").

       The normal usage pattern is using io_wait to know when a descriptor is writable, and then calling iob_send until it returns 0, -1 or -3.

       If it returns 0, terminate the loop (everything was written OK).  If it returns -1, call io_wait again.	If it returned -3, signal an error
       and close the socket.

       The benefit of the I/O batch API is that it exploits platform specific APIs like FreeBSD's sendfile.  The file contents will always be sent
       in a way that allows the operating systems to perform zero copy TCP, and the buffers will always be sent using as few syscalls as  possible
       and avoiding unnecessary copying (using writev).

SEE ALSO

       iob_reset(3), iob_send(3), iob_addbuf(3), iob_adds_free(3), iob_addfile(3), iob_prefetch(3)

																       iob_send(3)

iob_write(3)						     Library Functions Manual						      iob_write(3)

NAME

       iob_write - send I/O batch through callback

SYNTAX

       #include <iob.h>

       typedef int64 (*io_write_callback)(int64 s,const void* buf,uint64 n);

       int64 iob_write(int64 s,io_batch* b,io_write_callback cb);

DESCRIPTION

       iob_write sends the (rest of) b through the callback cb, passing s as first argument.  cb is expected to behave like io_trywrite(2).

       This  interface	is intended to send an I/O batch through a filter, for example to encrypt or compress it.  If you just want to send an I/O
       batch to a socket, use iob_send instead.

       iob_write returns the number of bytes written, 0 if there were no more bytes to be written in the batch, -1 for EAGAIN, or -3 for a  perma-
       nent error (for example "connection reset by peer").

       The normal usage pattern is using io_wait to know when a descriptor is writable, and then calling iob_write until it returns 0, -1 or -3.

       If  it  returns	0,  terminate  the  loop (everything was written OK).  If it returns -1, call io_wait again.  If it returned -3, signal an
       error.

NOTE

       iob_write will continue to call your callback until it returns an error.  So if you are in a state machine, for example a web server  using
       this  for  SSL  support,  make  sure  to  write at most n bytes at a time (e.g. 64k) and the next time you are called return -1.  Otherwise
       iob_write might not return until the whole file is served.

SEE ALSO

       iob_send(3)

																      iob_write(3)