Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
iob_init(3)		    Library Functions Manual		     iob_init(3)

NAME
     iob_init - initialize new I/O batch

SYNTAX
     #include <libowfat/iob.h>

     int iob_init(io_batch* b,size_t hint_entries);

DESCRIPTION
     iob_init  initializes  *b	with enough space allocated for hint_entries en-
     tries (buffers or files). This is purely a performance hint, if you are un-
     sure just pass 1.

     You can add buffers, strings and files to an I/O batch and then send it all
     at once using iob_send.

     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 unneces-
     sary copying (using writev).

RETURN VALUE
     iob_init  returns	0 on success. If there was a memory allocation error, it
     returns -1 instead.

SEE ALSO
     iob_new(3), iob_init_autofree(3), iob_reset(3), iob_send(3), iob_addbuf(3),
     iob_adds_free(3), iob_addfile(3)

								     iob_init(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=libowfat_iob_init&sektion=3&manpath=FreeBSD+Ports+15.1.quarterly>

home | help