summaryrefslogtreecommitdiff
path: root/docs/man/nng_iov.5.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2018-03-15 08:40:17 -0700
committerGarrett D'Amore <garrett@damore.org>2018-03-17 08:49:12 -0700
commit98f23e10cc1d65da6a7f6c7e4f5665d7afc27a86 (patch)
treee3cc06524b26fd0773d1742de82a00862f95c5f6 /docs/man/nng_iov.5.adoc
parent91866ed9365ab89069c12da41c873c23d0ba1d19 (diff)
downloadnng-98f23e10cc1d65da6a7f6c7e4f5665d7afc27a86.tar.gz
nng-98f23e10cc1d65da6a7f6c7e4f5665d7afc27a86.tar.bz2
nng-98f23e10cc1d65da6a7f6c7e4f5665d7afc27a86.zip
fixes #286 nng_pair0_open (and all others) need man page
fixes #279 consider restructuring man sections This represents a rather significant rework, and major editing effort, for the entire set of manual pages. All of the pages now have a section number in their filename; this assists in some other tooling, particularly ebook generation as every link needs to be programmatically modified when combined into an ebook. Section 5 is introduced, and populated with pages for the main types, and all options are now documented. Numerous errors have been corrected, including rewriting certain portions such as the header section of the surveyor protocol. Much work has been done to facilitate index generation, although certainly more work remains here. Every internal link within these pages now resolves; there are no more dead links. (This is required to generate Kindle format books.)
Diffstat (limited to 'docs/man/nng_iov.5.adoc')
-rw-r--r--docs/man/nng_iov.5.adoc54
1 files changed, 54 insertions, 0 deletions
diff --git a/docs/man/nng_iov.5.adoc b/docs/man/nng_iov.5.adoc
new file mode 100644
index 00000000..63d8b03b
--- /dev/null
+++ b/docs/man/nng_iov.5.adoc
@@ -0,0 +1,54 @@
+= nng_sockaddr_in(5)
+//
+// Copyright 2018 Staysail Systems, Inc. <info@staysail.tech>
+// Copyright 2018 Capitar IT Group BV <info@capitar.com>
+//
+// This document is supplied under the terms of the MIT License, a
+// copy of which should be located in the distribution where this
+// file was obtained (LICENSE.txt). A copy of the license may also be
+// found online at https://opensource.org/licenses/MIT.
+//
+
+== NAME
+
+nng_iov - scatter/gather element
+
+== SYNOPSIS
+
+[source, c]
+----
+#include <nng/nng.h>
+
+typedef struct {
+ void * iov_buf;
+ size_t iov_len;
+} nng_iov;
+----
+
+== DESCRIPTION
+
+An `nng_iov` structure represents a single element in a ((scatter/gather))
+array.
+Some operations can use arrays of these to access different regions of
+memory in a single operation.
+For example, it may be useful to send a message with header data from
+one part of memory, and a user payload from another.
+
+The operations that do this typically store an array of these in
+an <<nng_aio.5#,`nng_aio`>> structure using the
+<<nng_aio_set_iov.3#,`nng_aio_set_iov()`>> function.
+
+The following structure members are present:
+
+`iov_buf`::
+ This is a pointer to the first byte within the memory being
+ referenced by this scatter/gather element.
+
+`iov_len`::
+ This is the size in bytes of this scatter/gather element.
+
+== SEE ALSO
+
+<<nng_aio_set_iov.3#,nng_aio_set_iov(3)>>,
+<<nng_aio.5#,nng_aio(5)>>,
+<<nng.7#,nng(7)>>