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

Remove data from end of message header.

### Synopsis

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

int nng_msg_header_chop(nng_msg *msg, size_t size);
int nng_msg_header_chop_u16(nng_msg *msg, uint16_t *val16);
int nng_msg_header_chop_u32(nng_msg *msg, uint32_t *val32);
int nng_msg_header_chop_u64(nng_msg *msg, uint64_t *val64);
```

### Description

Theses functions remove data from the end of the header of message _msg_.

The `nng_msg_header_chop` function removes _size_ bytes.
The remaining functions remove 2, 4, or 8 bytes, and stores them in the value (such as _val32_),
after converting them from network-byte order (big-endian) to native byte order.

### Return Values

These function return 0 on success, and non-zero otherwise.

### Errors

[horizontal]
`NNG_EINVAL`:: The message header is too short to remove the requested data.

### See Also

xref:nng_msg_header.adoc[nng_msg_header],
xref:nng_msg_header_append.adoc[nng_msg_header_append],
xref:nng_msg_header_insert.adoc[nng_msg_header_insert],
xref:nng_msg_header_len.adoc[nng_msg_header_len],
xref:nng_msg_header_trim.adoc[nng_msg_header_trim]