diff options
| author | Garrett D'Amore <garrett@damore.org> | 2018-02-06 16:07:10 -0800 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2018-02-06 16:07:10 -0800 |
| commit | 51bebe0c6f137d293dbb6f1194ad3f6fca5b79e9 (patch) | |
| tree | f320ab2eec336cb781aa3774260e99a35d97e991 /docs/nng_aio_set_output.adoc | |
| parent | 3b33f6878ee628da22fd4451f248c036aae231ed (diff) | |
| download | nng-51bebe0c6f137d293dbb6f1194ad3f6fca5b79e9.tar.gz nng-51bebe0c6f137d293dbb6f1194ad3f6fca5b79e9.tar.bz2 nng-51bebe0c6f137d293dbb6f1194ad3f6fca5b79e9.zip | |
Document HTTP server API completely.
Diffstat (limited to 'docs/nng_aio_set_output.adoc')
| -rw-r--r-- | docs/nng_aio_set_output.adoc | 62 |
1 files changed, 62 insertions, 0 deletions
diff --git a/docs/nng_aio_set_output.adoc b/docs/nng_aio_set_output.adoc new file mode 100644 index 00000000..0c0c6cb9 --- /dev/null +++ b/docs/nng_aio_set_output.adoc @@ -0,0 +1,62 @@ += nng_aio_set_output(3) +:doctype: manpage +:manmanual: nng +:mansource: nng +:manvolnum: 3 +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. + +== NAME + +nng_aio_set_output - set output result + +== SYNOPSIS + +[source, c] +----------- +#include <nng/nng.h> + +void nng_aio_set_output(nng_aio *aio, unsigned int index, void *result); +----------- + +== DESCRIPTION + +The `nng_aio_set_output()` function sets the output result at _index_ +to _result_ for the asynchronous operation associated with _aio_. + +The type and semantics of output results are determined by specific +operations; the operation must supply appropriate output results when +the operation completes successfully. + +The valid values of _index_ range from zero (0) to three (3), as no operation +currently defined can return more than four results. (This limit could +increase in the future.) + +NOTE: Note that attempts to set results with an _index_ greater than +three (3) will be ignored. + +An output result set with this function may be retrieved later with +the <<nng_aio_get_output#,nng_aio_get_output(3)>> function. + +== RETURN VALUES + +None. + +== ERRORS + +None. + +== SEE ALSO + +<<nng_aio_alloc#,nng_aio_alloc(3)>>, +<<nng_aio_finish#,nng_aio_finish(3)>>, +<<nng_aio_get_output#,nng_aio_get_output(3)>>, +<<nng_aio_result#,nng_aio_result(3)>>, +<<nng#,nng(7)>> + +== COPYRIGHT + +{copyright} |
