blob: 63d8b03b981d5250868d4848ec836f2537f3d5be (
plain)
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
|
= nng_sockaddr_in(5)
//
// 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_iov - scatter/gather element
== SYNOPSIS
[source, c]
----
#include <nng/nng.h>
typedef struct {
void * iov_buf;
size_t iov_len;
} nng_iov;
----
== DESCRIPTION
An `nng_iov` structure represents a single element in a ((scatter/gather))
array.
Some operations can use arrays of these to access different regions of
memory in a single operation.
For example, it may be useful to send a message with header data from
one part of memory, and a user payload from another.
The operations that do this typically store an array of these in
an <<nng_aio.5#,`nng_aio`>> structure using the
<<nng_aio_set_iov.3#,`nng_aio_set_iov()`>> function.
The following structure members are present:
`iov_buf`::
This is a pointer to the first byte within the memory being
referenced by this scatter/gather element.
`iov_len`::
This is the size in bytes of this scatter/gather element.
== SEE ALSO
<<nng_aio_set_iov.3#,nng_aio_set_iov(3)>>,
<<nng_aio.5#,nng_aio(5)>>,
<<nng.7#,nng(7)>>
|
