diff options
| author | Garrett D'Amore <garrett@damore.org> | 2024-10-24 22:58:47 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2024-10-24 22:58:47 -0700 |
| commit | 2ac729f333395659c527a21fbcda128b46af7352 (patch) | |
| tree | ac74c91d043cac21e66e856f73dd4bbd52b2eb64 /docs/man/nng_aio_set_input.3.adoc | |
| parent | 3b1615c0dea75b082b7d27b73fbce65a836a87e2 (diff) | |
| download | nng-2ac729f333395659c527a21fbcda128b46af7352.tar.gz nng-2ac729f333395659c527a21fbcda128b46af7352.tar.bz2 nng-2ac729f333395659c527a21fbcda128b46af7352.zip | |
docs: AIO chapter (consumer only) converted to mdbook.
Diffstat (limited to 'docs/man/nng_aio_set_input.3.adoc')
| -rw-r--r-- | docs/man/nng_aio_set_input.3.adoc | 63 |
1 files changed, 0 insertions, 63 deletions
diff --git a/docs/man/nng_aio_set_input.3.adoc b/docs/man/nng_aio_set_input.3.adoc deleted file mode 100644 index 37cf3cdd..00000000 --- a/docs/man/nng_aio_set_input.3.adoc +++ /dev/null @@ -1,63 +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. - -IMPORTANT: 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 xref:nng_aio_get_input.3.adoc[`nng_aio_get_input()`] function. - -== RETURN VALUES - -None. - -== ERRORS - -None. - -== SEE ALSO - -[.text-left] -xref:nng_aio_alloc.3.adoc[nng_aio_alloc(3)], -xref:nng_aio_get_input.3.adoc[nng_aio_get_input(3)], -xref:nng_aio_get_output.3.adoc[nng_aio_get_output(3)], -xref:nng_aio_result.3.adoc[nng_aio_result(3)], -xref:nng_aio.5.adoc[nng_aio(5)], -xref:nng.7.adoc[nng(7)] |