FM / include

/usr/include

Name	Size	Mode	Actions
arpa/	-	0755	rm
asm/	-	0755	rm
asm-generic/	-	0755	rm
bind9/	-	0755	rm
bits/	-	0755	rm
blkid/	-	0755	rm
brotli/	-	0755	rm
c++/	-	0755	rm
drm/	-	0755	rm
e2p/	-	0755	rm
et/	-	0755	rm
event2/	-	0755	rm
ext2fs/	-	0755	rm
finclude/	-	0755	rm
fontconfig/	-	0755	rm
freetype2/	-	0755	rm
fstrm/	-	0755	rm
fwctl/	-	0755	rm
gdbm/	-	0755	rm
gio-unix-2.0/	-	0755	rm
GL/	-	0755	rm
glib-2.0/	-	0755	rm
gnu/	-	0755	rm
google/	-	0755	rm
graphite2/	-	0755	rm
gssapi/	-	0755	rm
gssrpc/	-	0755	rm
harfbuzz/	-	0755	rm
json-c/	-	0755	rm
kadm5/	-	0755	rm
krb5/	-	0755	rm
libexslt/	-	0755	rm
libltdl/	-	0755	rm
libmount/	-	0755	rm
libpng16/	-	0755	rm
libxml2/	-	0755	rm
libxslt/	-	0755	rm
linux/	-	0755	rm
lzma/	-	0755	rm
misc/	-	0755	rm
mtd/	-	0755	rm
mysql/	-	0755	rm
ncurses/	-	0755	rm
ncursesw/	-	0755	rm
net/	-	0755	rm
netash/	-	0755	rm
netatalk/	-	0755	rm
netax25/	-	0755	rm
neteconet/	-	0755	rm
netinet/	-	0755	rm
netipx/	-	0755	rm
netiucv/	-	0755	rm
netpacket/	-	0755	rm
netrom/	-	0755	rm
netrose/	-	0755	rm
nfs/	-	0755	rm
openssl/	-	0755	rm
pcp/	-	0755	rm
protobuf-c/	-	0755	rm
protocols/	-	0755	rm
python3.9/	-	0755	rm
rdma/	-	0755	rm
rpc/	-	0755	rm
scsi/	-	0755	rm
security/	-	0755	rm
selinux/	-	0755	rm
sepol/	-	0755	rm
sound/	-	0755	rm
sys/	-	0755	rm
sysprof-4/	-	0755	rm
unicode/	-	0755	rm
video/	-	0755	rm
webp/	-	0755	rm
X11/	-	0755	rm
xcb/	-	0755	rm
xen/	-	0755	rm
a.out.h	4351	0644	edit dl rm
aio.h	7738	0644	edit dl rm
aliases.h	2028	0644	edit dl rm
alloca.h	1203	0644	edit dl rm
ar.h	1731	0644	edit dl rm
argp.h	25548	0644	edit dl rm
argz.h	6051	0644	edit dl rm
assert.h	4562	0644	edit dl rm
autosprintf.h	2421	0644	edit dl rm
byteswap.h	1449	0644	edit dl rm
bzlib.h	6240	0644	edit dl rm
complex.h	8140	0644	edit dl rm
com_err.h	2118	0644	edit dl rm
cpio.h	2268	0644	edit dl rm
cpuidle.h	931	0644	edit dl rm
crypt.h	11160	0644	edit dl rm
ctype.h	10969	0644	edit dl rm
curses.h	99147	0644	edit dl rm
cursesapp.h	7230	0644	edit dl rm
cursesf.h	28029	0644	edit dl rm
cursesm.h	19908	0644	edit dl rm
cursesp.h	8751	0644	edit dl rm
cursesw.h	50306	0644	edit dl rm
cursslk.h	7321	0644	edit dl rm
dbm.h	1403	0644	edit dl rm
dirent.h	12617	0644	edit dl rm
dlfcn.h	8802	0644	edit dl rm
elf.h	182542	0644	edit dl rm
endian.h	2299	0644	edit dl rm
entities.h	4930	0644	edit dl rm
envz.h	2867	0644	edit dl rm
err.h	2341	0644	edit dl rm
errno.h	1679	0644	edit dl rm
error.h	2416	0644	edit dl rm
eti.h	2969	0644	edit dl rm
etip.h	9836	0644	edit dl rm
evdns.h	2019	0644	edit dl rm
event.h	2744	0644	edit dl rm
evhttp.h	2035	0644	edit dl rm
evrpc.h	2015	0644	edit dl rm
evutil.h	1782	0644	edit dl rm
execinfo.h	1523	0644	edit dl rm
expat.h	44273	0644	edit dl rm
expat_config.h	3910	0644	edit dl rm
expat_external.h	6029	0644	edit dl rm
fcntl.h	11442	0644	edit dl rm
features-time64.h	1404	0644	edit dl rm
features.h	18116	0644	edit dl rm
fenv.h	5788	0644	edit dl rm
ffi-x86_64.h	14209	0644	edit dl rm
ffi.h	556	0644	edit dl rm
ffitarget-x86_64.h	4741	0644	edit dl rm
ffitarget.h	616	0644	edit dl rm
FlexLexer.h	6893	0644	edit dl rm
fmtmsg.h	3240	0644	edit dl rm
fnmatch.h	2296	0644	edit dl rm
form.h	18900	0644	edit dl rm
fpu_control.h	3584	0644	edit dl rm
fstab.h	3111	0644	edit dl rm
fstrm.h	13017	0644	edit dl rm
fts.h	9579	0644	edit dl rm
ftw.h	6343	0644	edit dl rm
gconv.h	4211	0644	edit dl rm
gd.h	59643	0644	edit dl rm
gdbm.h	12181	0644	edit dl rm
gdcache.h	2994	0644	edit dl rm
gdfontg.h	553	0644	edit dl rm
gdfontl.h	551	0644	edit dl rm
gdfontmb.h	519	0644	edit dl rm
gdfonts.h	515	0644	edit dl rm
gdfontt.h	546	0644	edit dl rm
gdfx.h	496	0644	edit dl rm
gdpp.h	51947	0644	edit dl rm
gd_color_map.h	478	0644	edit dl rm
gd_errors.h	1503	0644	edit dl rm
gd_io.h	3002	0644	edit dl rm
getopt.h	1469	0644	edit dl rm
gettext-po.h	15548	0644	edit dl rm
glob.h	7299	0644	edit dl rm
gnu-versions.h	2343	0644	edit dl rm
gnumake.h	2912	0644	edit dl rm
gpg-error.h	73651	0644	edit dl rm
gpgrt.h	73651	0644	edit dl rm
grp.h	6687	0644	edit dl rm
gshadow.h	4529	0644	edit dl rm
gssapi.h	181	0644	edit dl rm
iconv.h	1858	0644	edit dl rm
idn-free.h	2618	0644	edit dl rm
idn-int.h	20	0644	edit dl rm
idna.h	3981	0644	edit dl rm
ieee754.h	4916	0644	edit dl rm
ifaddrs.h	2841	0644	edit dl rm
inttypes.h	8337	0644	edit dl rm
jconfig-64.h	2029	0644	edit dl rm
jconfig.h	246	0644	edit dl rm
jerror.h	15715	0644	edit dl rm
jmorecfg.h	14317	0644	edit dl rm
jpegint.h	15619	0644	edit dl rm
jpeglib.h	50281	0644	edit dl rm
kdb.h	64333	0644	edit dl rm
keyutils.h	11796	0644	edit dl rm
krad.h	8933	0644	edit dl rm
krb5.h	402	0644	edit dl rm
langinfo.h	17849	0644	edit dl rm
lastlog.h	126	0644	edit dl rm
libaio.h	8965	0644	edit dl rm
libgen.h	1386	0644	edit dl rm
libintl.h	4580	0644	edit dl rm
limits.h	5706	0644	edit dl rm
link.h	7801	0644	edit dl rm
lmdb.h	74014	0644	edit dl rm
locale.h	7675	0644	edit dl rm
ltdl.h	5709	0644	edit dl rm
lzma.h	9866	0644	edit dl rm
malloc.h	5912	0644	edit dl rm
math.h	48773	0644	edit dl rm
maxminddb.h	8543	0644	edit dl rm
maxminddb_config-64.h	504	0644	edit dl rm
maxminddb_config.h	178	0644	edit dl rm
mcheck.h	2435	0644	edit dl rm
memory.h	956	0644	edit dl rm
menu.h	11875	0644	edit dl rm
mntent.h	3359	0644	edit dl rm
monetary.h	1966	0644	edit dl rm
mqueue.h	4603	0644	edit dl rm
ncurses.h	99147	0644	edit dl rm
ncurses_dll.h	4043	0644	edit dl rm
nc_tparm.h	4777	0644	edit dl rm
ndbm.h	2443	0644	edit dl rm
netdb.h	28461	0644	edit dl rm
nl_types.h	1753	0644	edit dl rm
nss.h	14408	0644	edit dl rm
obstack.h	21307	0644	edit dl rm
panel.h	4512	0644	edit dl rm
paths.h	2977	0644	edit dl rm
pcre.h	31718	0644	edit dl rm
pcre2.h	47257	0644	edit dl rm
pcre2posix.h	6677	0644	edit dl rm
pcrecpp.h	26529	0644	edit dl rm
pcrecpparg.h	6783	0644	edit dl rm
pcreposix.h	5881	0644	edit dl rm
pcre_scanner.h	6600	0644	edit dl rm
pcre_stringpiece.h	6312	0644	edit dl rm
png.h	142860	0644	edit dl rm
pngconf.h	22846	0644	edit dl rm
pnglibconf.h	7605	0644	edit dl rm
poll.h	22	0644	edit dl rm
powercap.h	1660	0644	edit dl rm
pr29.h	2242	0644	edit dl rm
printf.h	6875	0644	edit dl rm
proc_service.h	3477	0644	edit dl rm
profile.h	12154	0644	edit dl rm
pthread.h	48524	0644	edit dl rm
pty.h	1570	0644	edit dl rm
punycode.h	9523	0644	edit dl rm
pwd.h	6317	0644	edit dl rm
regex.h	25904	0644	edit dl rm
regexp.h	1448	0644	edit dl rm
resolv.h	12387	0644	edit dl rm
re_comp.h	963	0644	edit dl rm
sched.h	5038	0644	edit dl rm
search.h	5450	0644	edit dl rm
semaphore.h	3464	0644	edit dl rm
setjmp.h	3190	0644	edit dl rm
sgtty.h	1344	0644	edit dl rm
shadow.h	5472	0644	edit dl rm
signal.h	13040	0644	edit dl rm
spawn.h	8297	0644	edit dl rm
stab.h	264	0644	edit dl rm
stdc-predef.h	2290	0644	edit dl rm
stdint.h	8474	0644	edit dl rm
stdio.h	31411	0644	edit dl rm
stdio_ext.h	2800	0644	edit dl rm
stdlib.h	36316	0644	edit dl rm
string.h	19459	0644	edit dl rm
stringprep.h	9758	0644	edit dl rm
strings.h	4753	0644	edit dl rm
syscall.h	25	0644	edit dl rm
sysexits.h	5232	0644	edit dl rm
syslog.h	24	0644	edit dl rm
tar.h	3786	0644	edit dl rm
term.h	41934	0644	edit dl rm
termcap.h	3474	0644	edit dl rm
termio.h	214	0644	edit dl rm
termios.h	3599	0644	edit dl rm
term_entry.h	9110	0644	edit dl rm
tgmath.h	40180	0644	edit dl rm
threads.h	7686	0644	edit dl rm
thread_db.h	16024	0644	edit dl rm
tic.h	14830	0644	edit dl rm
tiff.h	47444	0644	edit dl rm
tiffconf-64.h	3266	0644	edit dl rm
tiffconf.h	250	0644	edit dl rm
tiffio.h	24707	0644	edit dl rm
tiffio.hxx	1658	0644	edit dl rm
tiffvers.h	410	0644	edit dl rm
time.h	14848	0644	edit dl rm
tld.h	4963	0644	edit dl rm
ttyent.h	2494	0644	edit dl rm
uchar.h	2002	0644	edit dl rm
ucontext.h	2037	0644	edit dl rm
ulimit.h	1584	0644	edit dl rm
unctrl.h	3177	0644	edit dl rm
unistd.h	44489	0644	edit dl rm
utime.h	1905	0644	edit dl rm
utmp.h	3223	0644	edit dl rm
utmpx.h	4100	0644	edit dl rm
values.h	1956	0644	edit dl rm
verto-module.h	6640	0644	edit dl rm
verto.h	19437	0644	edit dl rm
wait.h	22	0644	edit dl rm
wchar.h	32142	0644	edit dl rm
wctype.h	5549	0644	edit dl rm
wordexp.h	2502	0644	edit dl rm
zconf.h	16262	0644	edit dl rm
zlib.h	96261	0644	edit dl rm

Edit: /usr/include/fstrm.h (13017B)

/*
 * Copyright (c) 2013-2014 by Farsight Security, Inc.
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be included
 * in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 */

/*! \file
 * \mainpage Introduction
 *
 * This is `fstrm`, a C implementation of the Frame Streams data transport
 * protocol.
 *
 * Frame Streams is a light weight, binary clean protocol that allows for the
 * transport of arbitrarily encoded data payload sequences with minimal framing
 * overhead -- just four bytes per data frame. Frame Streams does not specify an
 * encoding format for data frames and can be used with any data serialization
 * format that produces byte sequences, such as [Protocol Buffers], [XML],
 * [JSON], [MessagePack], [YAML], etc. Frame Streams can be used as both a
 * streaming transport over a reliable byte stream socket (TCP sockets, TLS
 * connections, `AF_UNIX` sockets, etc.) for data in motion as well as a file
 * format for data at rest. A "Content Type" header identifies the type of
 * payload being carried over an individual Frame Stream and allows cooperating
 * programs to determine how to interpret a given sequence of data payloads.
 *
 * `fstrm` is an optimized C implementation of Frame Streams that includes a
 * fast, lockless circular queue implementation and exposes library interfaces
 * for setting up a dedicated Frame Streams I/O thread and asynchronously
 * submitting data frames for transport from worker threads. It was originally
 * written to facilitate the addition of high speed binary logging to DNS
 * servers written in C using the [dnstap] log format.
 *
 * This is the API documentation for the `fstrm` library. For the project
 * hosting site, see <https://github.com/farsightsec/fstrm>.
 *
 * \authors Farsight Security, Inc. and the `fstrm` authors.
 *
 * \copyright 2013-2018. Licensed under the terms of the [MIT] license.
 *
 * [Protocol Buffers]: https://developers.google.com/protocol-buffers/
 * [XML]:              http://www.w3.org/TR/xml11/
 * [JSON]:             http://www.json.org/
 * [MessagePack]:      http://msgpack.org/
 * [YAML]:             http://www.yaml.org/
 * [dnstap]:           http://dnstap.info/
 * [MIT]:              https://opensource.org/licenses/MIT
 *
 * \page overview Library overview
 *
 * \section init Initializing the library
 *
 * `fstrm` has no global library state. In most cases, only a single
 * \ref fstrm_iothr library context object will be needed for the entire process,
 * which will implicitly create a background I/O serialization thread. This I/O
 * thread is bound to a particular output writer (for example, an `AF_UNIX`
 * socket) and is fully buffered -- submitted data frames will be accumulated in
 * an output buffer and periodically flushed, minimizing the number of system
 * calls that need to be performed. This frees worker threads from waiting for a
 * write() to complete.
 *
 * `fstrm` abstracts the actual I/O operations needed to read or write a byte
 * stream. File and socket I/O implementations are included in the library, but
 * if necessary `fstrm` can be extended to support new types of byte stream
 * transports. See the \ref fstrm_reader, \ref fstrm_writer, and \ref fstrm_rdwr
 * interfaces for details.
 *
 * The following code example shows the initialization of an `fstrm_iothr`
 * library context object connected to an \ref fstrm_file writer.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        const char *file_path = "/tmp/output.fs";
        struct fstrm_file_options *fopt;
        struct fstrm_iothr *iothr;
        struct fstrm_writer *writer;

fopt = fstrm_file_options_init();
        fstrm_file_options_set_file_path(fopt, file_path);

writer = fstrm_file_writer_init(fopt, NULL);
        if (!writer) {
                fprintf(stderr, "Error: fstrm_file_writer_init() failed.\n");
                exit(EXIT_FAILURE);
        }

iothr = fstrm_iothr_init(NULL, &writer);
        if (!iothr) {
                fprintf(stderr, "Error: fstrm_iothr_init() failed.\n");
                exit(EXIT_FAILURE);
        }

fstrm_file_options_destroy(&fopt);
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 *
 * Since the I/O operations are abstracted through the `fstrm_writer` interface,
 * the `writer` variable in the above example could instead have been
 * initialized with a completely different implementation. For example,
 * \ref fstrm_unix_writer objects can be initialized as follows:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        const char *socket_path = "/tmp/output.sock";
        struct fstrm_writer *writer;
        struct fstrm_unix_writer_options *uwopt;

uwopt = fstrm_unix_writer_options_init();
        fstrm_unix_writer_options_set_socket_path(uwopt, socket_path);

writer = fstrm_unix_writer_init(uwopt, NULL);
        if (!writer) {
                fprintf(stderr, "Error: fstrm_unix_writer_init() failed.\n");
                exit(EXIT_FAILURE);
        }
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 *
 * \section queue Getting an input queue
 *
 * After the `fstrm_iothr` object has been created with fstrm_iothr_init(), an
 * input queue handle can be obtained with the fstrm_iothr_get_input_queue()
 * function, which returns an `fstrm_iothr_queue` object. This function is
 * thread-safe and returns a unique queue each time it is called, up to the
 * number of queues specified by fstrm_iothr_options_set_num_input_queues().
 * `fstrm_iothr_queue` objects belong to their parent `fstrm_iothr` object and
 * will be destroyed when the parent `fstrm_iothr` object is destroyed.
 *
 * The following code example shows a single `fstrm_iothr_queue` handle being
 * obtained from an already initialized `fstrm_iothr` library context object.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        // 'iothr' is a struct fstrm_iothr *

struct fstrm_iothr_queue *ioq;
        ioq = fstrm_iothr_get_input_queue(iothr);
        if (!ioq) {
                fprintf(stderr, "Error: fstrm_iothr_get_input_queue() failed.\n");
                exit(EXIT_FAILURE);
        }
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 *
 * \section submit Submitting data frames
 *
 * Once the `fstrm_iothr` object has been created and an `fstrm_iothr_queue`
 * handle is available, data frames can be submitted for asynchronous writing
 * using the fstrm_iothr_submit() function. A callback is passed to this
 * function which will be invoked to deallocate the data frame once the I/O
 * thread has completed processing it. In the common case where the data frame
 * is dynamically allocated with `malloc()`, the deallocation callback must call
 * `free()`. fstrm_free_wrapper() is provided as a convenience function which
 * does this and can be specified as the `free_func` parameter to
 * fstrm_iothr_submit().
 *
 * If space is available in the queue, fstrm_iothr_submit() will return
 * #fstrm_res_success, indicating that ownership of the memory allocation for the
 * data frame has passed from the caller to the library. The caller must not
 * reuse or deallocate the memory for the data frame after a successful call to
 * fstrm_iothr_submit().
 *
 * Callers must check the return value of fstrm_iothr_submit(). If this function
 * fails, that is, it returns any result code other than #fstrm_res_success, the
 * caller must deallocate or otherwise dispose of memory allocated for the data
 * frame, in order to avoid leaking memory. fstrm_iothr_submit() can fail with
 * #fstrm_res_again if there is currently no space in the circular queue for an
 * additional frame, in which case a later call to fstrm_iothr_submit() with the
 * same parameters may succeed. However, if fstrm_iothr_submit() fails with
 * #fstrm_res_invalid, then there is a problem with the parameters and a later
 * call will not succeed.
 *
 * The following code example shows data frames containing a short sequence of
 * bytes being created and submitted repeatedly, with appropriate error
 * handling. Note that the data frames in this example intentionally contain
 * embedded unprintable characters, showing that Frame Streams is binary clean.
 * This example follows from the previous examples, where the `iothr` and `ioq`
 * variables have already been initialized.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        // 'iothr' is a struct fstrm_iothr *
        // 'ioq' is a struct fstrm_queue *

const unsigned num_frames = 100;
        const uint8_t frame_template[] = {
                'H', 'e', 'l', 'l', 'o', 0x00, 0x01, 0x02, 0x03,
                'W', 'o', 'r', 'l', 'd', 0x04, 0x05, 0x06, 0x07,
        };

for (unsigned i = 0; i < num_frames; i++) {
                // Allocate a new frame from the template.
                uint8_t *frame = malloc(sizeof(frame_template));
                if (!frame)
                        break;
                memcpy(frame, frame_template, sizeof(frame_template));

// Submit the frame for writing.
                for (;;) {
                        fstrm_res res;
                        res = fstrm_iothr_submit(iothr, ioq, frame,
                                                 sizeof(frame_template),
                                                 fstrm_free_wrapper, NULL);
                        if (res == fstrm_res_success) {
                                // Frame successfully queued.
                                break;
                        } else if (res == fstrm_res_again) {
                                // Queue is full. Try again in a busy loop.
                                // Alternatively, if loss can be tolerated we
                                // could free the frame here and break out of
                                // the loop.
                                continue;
                        } else {
                                // Permanent failure.
                                free(frame);
                                fputs("fstrm_iothr_submit() failed.\n", stderr);
                                break;
                        }
                }
        }
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 *
 * \section shutdown Shutting down
 *
 * Calling fstrm_iothr_destroy() on the `fstrm_iothr` object will signal the I/O
 * thread to flush any outstanding data frames being written and will deallocate
 * all associated resources. This function is synchronous and does not return
 * until the I/O thread has terminated.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        // 'iothr' is a struct fstrm_iothr *
        fstrm_iothr_destroy(&iothr);
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 */

#ifndef FSTRM_H
#define FSTRM_H

#ifdef __cplusplus
extern "C" {
#endif

#include <sys/uio.h>
#include <stddef.h>
#include <stdint.h>

/**
 * \defgroup fstrm_res fstrm_res
 *
 * Library result codes.
 * @{
 */

/**
 * Result codes for functions.
 */
typedef enum {
	/** Success. */
	fstrm_res_success,

/** Failure. */
	fstrm_res_failure,

/** Resource temporarily unavailable. */
	fstrm_res_again,

/** Parameters were invalid. */
	fstrm_res_invalid,

/** The end of a stream has been reached. */
	fstrm_res_stop,
} fstrm_res;

/**@}*/

struct fstrm_control;
struct fstrm_file_options;
struct fstrm_iothr;
struct fstrm_iothr_options;
struct fstrm_iothr_queue;
struct fstrm_rdwr;
struct fstrm_reader_options;
struct fstrm_unix_writer_options;
struct fstrm_writer;
struct fstrm_writer_options;

#include <fstrm/control.h>
#include <fstrm/file.h>
#include <fstrm/iothr.h>
#include <fstrm/rdwr.h>
#include <fstrm/reader.h>
#include <fstrm/tcp_writer.h>
#include <fstrm/unix_writer.h>
#include <fstrm/writer.h>

#ifdef __cplusplus
}
#endif

#endif /* FSTRM_H */

cmd: