Gecko [ xn--ilmaispyrytykset-3nb63a.com ]

Name	Size	Permission
GL	[ DIR ]	drwxr-xr-x
X11	[ DIR ]	drwxr-xr-x
apache2	[ DIR ]	drwxr-xr-x
arpa	[ DIR ]	drwxr-xr-x
asm	[ DIR ]	drwxr-xr-x
asm-generic	[ DIR ]	drwxr-xr-x
bind9	[ DIR ]	drwxr-xr-x
bind9-export	[ DIR ]	drwxr-xr-x
bits	[ DIR ]	drwxr-xr-x
bsock	[ DIR ]	drwxr-xr-x
c++	[ DIR ]	drwxr-xr-x
drm	[ DIR ]	drwxr-xr-x
e2p	[ DIR ]	drwxr-xr-x
et	[ DIR ]	drwxr-xr-x
event2	[ DIR ]	drwxr-xr-x
ext2fs	[ DIR ]	drwxr-xr-x
finclude	[ DIR ]	drwxr-xr-x
fontconfig	[ DIR ]	drwxr-xr-x
freetype2	[ DIR ]	drwxr-xr-x
fstrm	[ DIR ]	drwxr-xr-x
gdb	[ DIR ]	drwxr-xr-x
gdbm	[ DIR ]	drwxr-xr-x
gnu	[ DIR ]	drwxr-xr-x
google	[ DIR ]	drwxr-xr-x
gssapi	[ DIR ]	drwxr-xr-x
gssrpc	[ DIR ]	drwxr-xr-x
json-c	[ DIR ]	drwxr-xr-x
kadm5	[ DIR ]	drwxr-xr-x
krb5	[ DIR ]	drwxr-xr-x
libdb	[ DIR ]	drwxr-xr-x
libexslt	[ DIR ]	drwxr-xr-x
libltdl	[ DIR ]	drwxr-xr-x
libpng16	[ DIR ]	drwxr-xr-x
libxml2	[ DIR ]	drwxr-xr-x
libxslt	[ DIR ]	drwxr-xr-x
linux	[ DIR ]	drwxr-xr-x
lve	[ DIR ]	drwxr-xr-x
lzma	[ DIR ]	drwxr-xr-x
misc	[ DIR ]	drwxr-xr-x
mtd	[ DIR ]	drwxr-xr-x
mysql	[ DIR ]	drwxr-xr-x
ncurses	[ DIR ]	drwxr-xr-x
ncursesw	[ DIR ]	drwxr-xr-x
net	[ DIR ]	drwxr-xr-x
netash	[ DIR ]	drwxr-xr-x
netatalk	[ DIR ]	drwxr-xr-x
netax25	[ DIR ]	drwxr-xr-x
neteconet	[ DIR ]	drwxr-xr-x
netinet	[ DIR ]	drwxr-xr-x
netipx	[ DIR ]	drwxr-xr-x
netiucv	[ DIR ]	drwxr-xr-x
netpacket	[ DIR ]	drwxr-xr-x
netrom	[ DIR ]	drwxr-xr-x
netrose	[ DIR ]	drwxr-xr-x
nfs	[ DIR ]	drwxr-xr-x
openssl	[ DIR ]	drwxr-xr-x
perf	[ DIR ]	drwxr-xr-x
protobuf-c	[ DIR ]	drwxr-xr-x
protocols	[ DIR ]	drwxr-xr-x
python2.7	[ DIR ]	drwxr-xr-x
python3.6m	[ DIR ]	drwxr-xr-x
rdma	[ DIR ]	drwxr-xr-x
rpc	[ DIR ]	drwxr-xr-x
rpcsvc	[ DIR ]	drwxr-xr-x
sasl	[ DIR ]	drwxr-xr-x
scsi	[ DIR ]	drwxr-xr-x
security	[ DIR ]	drwxr-xr-x
selinux	[ DIR ]	drwxr-xr-x
sepol	[ DIR ]	drwxr-xr-x
sound	[ DIR ]	drwxr-xr-x
sys	[ DIR ]	drwxr-xr-x
tirpc	[ DIR ]	drwxr-xr-x
unicode	[ DIR ]	drwxr-xr-x
uuid	[ DIR ]	drwxr-xr-x
video	[ DIR ]	drwxr-xr-x
webp	[ DIR ]	drwxr-xr-x
xcb	[ DIR ]	drwxr-xr-x
xen	[ DIR ]	drwxr-xr-x
FlexLexer.h	6.73 KB	-rw-r--r--
a.out.h	4.25 KB	-rw-r--r--
aio.h	7.28 KB	-rw-r--r--
aliases.h	1.98 KB	-rw-r--r--
alloca.h	1.17 KB	-rw-r--r--
ar.h	1.69 KB	-rw-r--r--
argp.h	24.82 KB	-rw-r--r--
argz.h	5.91 KB	-rw-r--r--
assert.h	4.45 KB	-rw-r--r--
autosprintf.h	2.33 KB	-rw-r--r--
byteswap.h	1.37 KB	-rw-r--r--
bzlib.h	6.1 KB	-rw-r--r--
com_err.h	2.07 KB	-rw-r--r--
complex.h	7 KB	-rw-r--r--
cpio.h	2.21 KB	-rw-r--r--
cpuidle.h	844 B	-rw-r--r--
crypt.h	8.9 KB	-rw-r--r--
ctype.h	10.71 KB	-rw-r--r--
curses.h	97.29 KB	-rw-r--r--
cursesapp.h	6.62 KB	-rw-r--r--
cursesf.h	27.2 KB	-rw-r--r--
cursesm.h	19.22 KB	-rw-r--r--
cursesp.h	8.4 KB	-rw-r--r--
cursesw.h	48.55 KB	-rw-r--r--
cursslk.h	7.13 KB	-rw-r--r--
db.h	120.22 KB	-r--r--r--
db_185.h	5.84 KB	-r--r--r--
dbm.h	1.38 KB	-rw-r--r--
dirent.h	12.19 KB	-rw-r--r--
dlfcn.h	7.07 KB	-rw-r--r--
elf.h	170.73 KB	-rw-r--r--
endian.h	3.11 KB	-rw-r--r--
entities.h	4.81 KB	-rw-r--r--
envz.h	2.8 KB	-rw-r--r--
err.h	2.16 KB	-rw-r--r--
errno.h	1.64 KB	-rw-r--r--
error.h	1.99 KB	-rw-r--r--
eti.h	2.82 KB	-rw-r--r--
etip.h	9.47 KB	-rw-r--r--
evdns.h	1.97 KB	-rw-r--r--
event.h	2.68 KB	-rw-r--r--
evhttp.h	1.99 KB	-rw-r--r--
evrpc.h	1.97 KB	-rw-r--r--
evutil.h	1.74 KB	-rw-r--r--
execinfo.h	1.49 KB	-rw-r--r--
expat.h	42.66 KB	-rw-r--r--
expat_config.h	3.43 KB	-rw-r--r--
expat_external.h	5.4 KB	-rw-r--r--
fcntl.h	10.7 KB	-rw-r--r--
features.h	15.69 KB	-rw-r--r--
fenv.h	5.72 KB	-rw-r--r--
fmtmsg.h	3.16 KB	-rw-r--r--
fnmatch.h	2.24 KB	-rw-r--r--
form.h	18.17 KB	-rw-r--r--
fpu_control.h	3.5 KB	-rw-r--r--
fstab.h	3.04 KB	-rw-r--r--
fstrm.h	12.71 KB	-rw-r--r--
fts.h	8.18 KB	-rw-r--r--
ftw.h	5.13 KB	-rw-r--r--
gconv.h	4.31 KB	-rw-r--r--
gcrypt.h	68.71 KB	-rw-r--r--
gd.h	56.42 KB	-rw-r--r--
gd_color_map.h	478 B	-rw-r--r--
gd_errors.h	1.47 KB	-rw-r--r--
gd_io.h	3.05 KB	-rw-r--r--
gdbm.h	10.1 KB	-rw-r--r--
gdcache.h	2.83 KB	-rw-r--r--
gdfontg.h	553 B	-rw-r--r--
gdfontl.h	551 B	-rw-r--r--
gdfontmb.h	519 B	-rw-r--r--
gdfonts.h	515 B	-rw-r--r--
gdfontt.h	546 B	-rw-r--r--
gdfx.h	497 B	-rw-r--r--
gdpp.h	50.94 KB	-rw-r--r--
getopt.h	1.43 KB	-rw-r--r--
gettext-po.h	15.17 KB	-rw-r--r--
glob.h	6.46 KB	-rw-r--r--
gnu-versions.h	2.29 KB	-rw-r--r--
gnumake.h	2.84 KB	-rw-r--r--
gpg-error.h	66.29 KB	-rw-r--r--
gpgrt.h	66.29 KB	-rw-r--r--
grp.h	6.53 KB	-rw-r--r--
gshadow.h	4.42 KB	-rw-r--r--
gssapi.h	181 B	-rw-r--r--
iconv.h	1.81 KB	-rw-r--r--
idn-free.h	2.41 KB	-rw-r--r--
idn-int.h	20 B	-rw-r--r--
idna.h	3.48 KB	-rw-r--r--
ieee754.h	4.79 KB	-rw-r--r--
ifaddrs.h	2.77 KB	-rw-r--r--
inttypes.h	11.61 KB	-rw-r--r--
jconfig-64.h	2.17 KB	-rw-r--r--
jconfig.h	246 B	-rw-r--r--
jerror.h	14.73 KB	-rw-r--r--
jmorecfg.h	14.7 KB	-rw-r--r--
jpegint.h	15.22 KB	-rw-r--r--
jpeglib.h	48.71 KB	-rw-r--r--
kdb.h	67.66 KB	-rw-r--r--
keyutils.h	7.52 KB	-rw-r--r--
krad.h	8.72 KB	-rw-r--r--
krb5.h	402 B	-rw-r--r--
langinfo.h	17.43 KB	-rw-r--r--
lastlog.h	126 B	-rw-r--r--
lauxlib.h	8.43 KB	-rw-r--r--
lber.h	14.95 KB	-rw-r--r--
lber_types.h	1.43 KB	-rw-r--r--
ldap.h	63.57 KB	-rw-r--r--
ldap_cdefs.h	9.24 KB	-rw-r--r--
ldap_features.h	1.77 KB	-rw-r--r--
ldap_schema.h	9.23 KB	-rw-r--r--
ldap_utf8.h	3.39 KB	-rw-r--r--
ldif.h	4.58 KB	-rw-r--r--
libaio.h	8.73 KB	-rw-r--r--
libgen.h	1.35 KB	-rw-r--r--
libintl.h	4.47 KB	-rw-r--r--
limits.h	5.29 KB	-rw-r--r--
link.h	7.05 KB	-rw-r--r--
locale.h	7.49 KB	-rw-r--r--
ltdl.h	5.58 KB	-rw-r--r--
lua.h	14.49 KB	-rw-r--r--
lua.hpp	191 B	-rw-r--r--
luaconf-x86_64.h	21.11 KB	-rw-r--r--
luaconf.h	1.62 KB	-rw-r--r--
lualib.h	1.27 KB	-rw-r--r--
lzma.h	9.59 KB	-rw-r--r--
malloc.h	5.96 KB	-rw-r--r--
math.h	52.07 KB	-rw-r--r--
mcheck.h	2.38 KB	-rw-r--r--
memory.h	955 B	-rw-r--r--
menu.h	11.91 KB	-rw-r--r--
mntent.h	3.28 KB	-rw-r--r--
monetary.h	1.76 KB	-rw-r--r--
mqueue.h	3.67 KB	-rw-r--r--
nc_tparm.h	4.1 KB	-rw-r--r--
ncurses.h	97.29 KB	-rw-r--r--
ncurses_dll.h	4.18 KB	-rw-r--r--
ndbm.h	2.4 KB	-rw-r--r--
netdb.h	27.44 KB	-rw-r--r--
nl_types.h	1.71 KB	-rw-r--r--
nss.h	1.83 KB	-rw-r--r--
obstack.h	20.81 KB	-rw-r--r--
panel.h	4.03 KB	-rw-r--r--
paths.h	2.91 KB	-rw-r--r--
pcre.h	30.97 KB	-rw-r--r--
pcre2.h	43.75 KB	-rw-r--r--
pcre2posix.h	5.67 KB	-rw-r--r--
pcre_scanner.h	6.45 KB	-rw-r--r--
pcre_stringpiece.h	6.16 KB	-rw-r--r--
pcrecpp.h	25.91 KB	-rw-r--r--
pcrecpparg.h	6.62 KB	-rw-r--r--
pcreposix.h	5.32 KB	-rw-r--r--
png.h	140.77 KB	-rw-r--r--
pngconf.h	22.31 KB	-rw-r--r--
pnglibconf.h	7.39 KB	-rw-r--r--
poll.h	22 B	-rw-r--r--
pr29.h	2.07 KB	-rw-r--r--
printf.h	6.64 KB	-rw-r--r--
proc_service.h	3.39 KB	-rw-r--r--
profile.h	11.87 KB	-rw-r--r--
pthread.h	40.3 KB	-rw-r--r--
pty.h	1.53 KB	-rw-r--r--
punycode.h	9.16 KB	-rw-r--r--
pwd.h	6.01 KB	-rw-r--r--
re_comp.h	962 B	-rw-r--r--
regex.h	24.14 KB	-rw-r--r--
regexp.h	1.41 KB	-rw-r--r--
resolv.h	11.79 KB	-rw-r--r--
sched.h	4.62 KB	-rw-r--r--
search.h	5.1 KB	-rw-r--r--
semaphore.h	2.34 KB	-rw-r--r--
setjmp.h	3.58 KB	-rw-r--r--
sgtty.h	1.31 KB	-rw-r--r--
shadow.h	5.34 KB	-rw-r--r--
signal.h	11.96 KB	-rw-r--r--
slapi-plugin.h	37.45 KB	-rw-r--r--
spawn.h	6.53 KB	-rw-r--r--
stab.h	264 B	-rw-r--r--
stdc-predef.h	2.24 KB	-rw-r--r--
stdint.h	8.27 KB	-rw-r--r--
stdio.h	29.46 KB	-rw-r--r--
stdio_ext.h	2.73 KB	-rw-r--r--
stdlib.h	34.82 KB	-rw-r--r--
string.h	17.17 KB	-rw-r--r--
stringprep.h	8.03 KB	-rw-r--r--
strings.h	4.64 KB	-rw-r--r--
syscall.h	25 B	-rw-r--r--
sysexits.h	5.11 KB	-rw-r--r--
syslog.h	24 B	-rw-r--r--
tar.h	3.7 KB	-rw-r--r--
term.h	40.22 KB	-rw-r--r--
term_entry.h	8.55 KB	-rw-r--r--
termcap.h	3.39 KB	-rw-r--r--
termio.h	214 B	-rw-r--r--
termios.h	3.51 KB	-rw-r--r--
tgmath.h	30.75 KB	-rw-r--r--
thread_db.h	15.65 KB	-rw-r--r--
threads.h	6.5 KB	-rw-r--r--
tic.h	13.32 KB	-rw-r--r--
tiff.h	35.14 KB	-rw-r--r--
tiffconf-64.h	3.35 KB	-rw-r--r--
tiffconf.h	250 B	-rw-r--r--
tiffio.h	22.68 KB	-rw-r--r--
tiffio.hxx	1.66 KB	-rw-r--r--
tiffvers.h	410 B	-rw-r--r--
time.h	10.12 KB	-rw-r--r--
tld.h	4.54 KB	-rw-r--r--
ttyent.h	2.44 KB	-rw-r--r--
uchar.h	1.95 KB	-rw-r--r--
ucontext.h	1.99 KB	-rw-r--r--
ulimit.h	1.55 KB	-rw-r--r--
unctrl.h	3.03 KB	-rw-r--r--
unistd.h	41.74 KB	-rw-r--r--
utime.h	1.47 KB	-rw-r--r--
utmp.h	3.15 KB	-rw-r--r--
utmpx.h	4 KB	-rw-r--r--
values.h	1.91 KB	-rw-r--r--
verto-module.h	6.48 KB	-rw-r--r--
verto.h	18.98 KB	-rw-r--r--
wait.h	22 B	-rw-r--r--
wchar.h	30.38 KB	-rw-r--r--
wctype.h	5.42 KB	-rw-r--r--
wordexp.h	2.44 KB	-rw-r--r--
zconf.h	15.88 KB	-rw-r--r--
zlib.h	94 KB	-rw-r--r--

Code Editor : fstrm.h

/*
 * 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 */

${this.title}

Code Editor : fstrm.h