summaryrefslogtreecommitdiff
path: root/docs/reference/src/msg/nng_msg_capacity.md
blob: 82c7ad07d634504e6d0c3bb66127b47571b2ed52 (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
# nng_msg_capacity

## NAME

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] _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

[nng_msg_alloc][nng_msg_alloc],
[nng_msg_realloc][nng_msg_realloc],
[nng_msg_reserve][nng_msg_reserve]
[nng_msg_body][nng_msg_body]

{{#include ../refs.md}}