File Manager

X7ROOT File Manager

Current Path: /usr/include

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

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

X7ROOT File Manager

Editing: fstrm.h

Upload File

Create Folder