aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_aio_set_iov.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_aio_set_iov.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_aio_set_iov.adoc')
-rw-r--r--docs/man/nng_aio_set_iov.adoc71
1 files changed, 0 insertions, 71 deletions
diff --git a/docs/man/nng_aio_set_iov.adoc b/docs/man/nng_aio_set_iov.adoc
deleted file mode 100644
index d5991ed6..00000000
--- a/docs/man/nng_aio_set_iov.adoc
+++ /dev/null
@@ -1,71 +0,0 @@
-= nng_aio_set_iov(3)
-//
-// 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_aio_set_iov - set scatter/gather vector
-
-== SYNOPSIS
-
-[source, c]
------------
-#include <nng/nng.h>
-
-int nng_aio_set_iov(nng_aio *aio, unsigned int niov, nng_iov *iov);
------------
-
-== DESCRIPTION
-
-The `nng_aio_set_iov()` function sets a scatter/gather vector _iov_ on the
-handle _aio_.
-
-The _iov_ is a pointer to an array of _niov_ `nng_iov` structures, which have
-the following definition:
-
-[source, c]
-----
- typedef struct nng_iov {
- void * iov_buf;
- size_t iov_len;
- };
-----
-
-The _iov_ is copied into storage in the _aio_ itself, so that callers
-may use stack allocated `nng_iov` structures. The values pointed to
-by the `iov_buf` members are *not* copied by this function though.
-
-Up to four `nng_iov` members may be supplied without causing any
-allocations, and thus this operation is guaranteed to succeed for
-values of _niov_ less than four.
-
-More than four (4) `nng_iov` members may be supplied, but this may require
-heap allocations, and so the operation may fail with `NNG_ENOMEM`.
-Additionally, not every operation can support longer vectors; the
-actual limit is determined by the system, but is generally at least
-sixteen (16). Furthermore, values for _niov_ larger than sixty-four (64) will
-generally result in `NNG_EINVAL`.
-
-== RETURN VALUES
-
-This function returns 0 on success, and non-zero otherwise.
-
-== ERRORS
-
-`NNG_ENOMEM`:: Insufficient free memory to perform operation.
-`NNG_EINVAL`:: Value of specified _niov_ is too large.
-
-== SEE ALSO
-
-<<nng_aio_alloc#,nng_aio_alloc(3)>>,
-<<nng_aio_cancel#,nng_aio_cancel(3)>>,
-<<nng_aio_count#,nng_aio_count(3)>>,
-<<nng_aio_result#,nng_aio_result(3)>>,
-<<nng#,nng(7)>>