NAME

buffer.h - generic read/write buffering

SYNTAX

#include <libowfat/buffer.h>

buffer* buffer_0; /* like stdio's stdin */
buffer* buffer_1; /* like stdio's stdout */
buffer* buffer_2; /* like stdio's stderr */

DESCRIPTION

buffer.h provides a generic buffer interface that can be used for read and write buffering. Buffers must be initialized with buffer_init.

A buffer can only be used for reading or writing at the same time, not both.

Unlike stdio, these write buffers are not flushed automatically at program termination; you must manually call buffer_flush, buffer_putsflush, buffer_putflush or buffer_putnlflush.

EXAMPLE

See buffer_init(3) for example read buffer code. Here is typical code for printing an error message on stderr:

#include <libowfat/buffer.h>

buffer_puts(buffer_2,"error: got only ");
buffer_putulong(buffer_2,got);
buffer_puts(buffer_2," bytes, but expected at least ");
buffer_putulong(buffer_2,expected);
buffer_putsflush(buffer_2," bytes!");

SEE ALSO

buffer_init(3), buffer_put(3), buffer_get(3), buffer_flush(3)