1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
|
= 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)>>
|
