summaryrefslogtreecommitdiff
path: root/docs/ref/msg/nng_msg_capacity.adoc
blob: 3ee76e2c8ef829c71dbb3e9391492013dfff3f89 (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
## nng_msg_capacity

Return message body length.

### Synopsis

```c
#include <nng/nng.h>

size_t nng_msg_capacity(nng_msg *msg);
```

### Description

The `nng_msg_capacity` returns the storage allocated for the body of message _msg_.
The capacity includes the current contents of the message and free space after it.
The message body may grow to capacity without performing any further allocations.

### Return Values

Allocated capacity for message body.

### See Also

xref:nng_msg_reserve.adoc[nng_msg_reserve],
xref:nng_msg_alloc.adoc[nng_msg_alloc],
xref:nng_msg_body.adoc[nng_msg_body]