aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_aio_set_input.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_input.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_input.adoc')
-rw-r--r--docs/man/nng_aio_set_input.adoc62
1 files changed, 0 insertions, 62 deletions
diff --git a/docs/man/nng_aio_set_input.adoc b/docs/man/nng_aio_set_input.adoc
deleted file mode 100644
index 3a240c6a..00000000
--- a/docs/man/nng_aio_set_input.adoc
+++ /dev/null
@@ -1,62 +0,0 @@
-= nng_aio_set_input(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_input - set input parameter
-
-== SYNOPSIS
-
-[source, c]
------------
-#include <nng/nng.h>
-
-void nng_aio_set_input(nng_aio *aio, unsigned int index, void *param);
------------
-
-== DESCRIPTION
-
-The `nng_aio_set_input()` function sets the input parameter at _index_
-to _param_ for the asynchronous operation associated with _aio_.
-
-The type and semantics of input parameters are determined by specific
-operations; the caller must supply appropriate inputs for the operation
-to be performed.
-
-The valid values of _index_ range from zero (0) to three (3), as no operation
-currently defined can accept more than four parameters. (This limit could
-increase in the future.)
-
-NOTE: If the _index_ does not correspond to a defined input for the operation,
-then this function will have no effect. Note that attempts to set
-parameters with an _index_ greater than three (3) will simply be ignored.
-
-CAUTION: It is an error to call this function while the _aio_ is currently
-in use by an active asynchronous operation.
-
-An input parameter set with this function may be retrieved later with
-the <<nng_aio_get_input#,nng_aio_get_input(3)>> function.
-
-== RETURN VALUES
-
-None.
-
-== ERRORS
-
-None.
-
-== SEE ALSO
-
-<<nng_aio_alloc#,nng_aio_alloc(3)>>,
-<<nng_aio_get_input#,nng_aio_get_input(3)>>,
-<<nng_aio_get_output#,nng_aio_get_output(3)>>,
-<<nng_aio_result#,nng_aio_result(3)>>,
-<<nng#,nng(7)>>