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
|
= nng_msg_header_trim(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_msg_header_trim, nng_msg_header_trim_u32 - remove data from start of message header
== SYNOPSIS
[source, c]
----
#include <nng/nng.h>
int nng_msg_header_trim(nng_msg *msg, size_t size);
int nng_msg_header_trim_u32(nng_msg *msg, uint32_t *val32);
----
== DESCRIPTION
The `nng_msg_header_trim()` and `nng_msg_header_trim_u32()` functions remove
data from the start of the header of message _msg_.
The first function removes _size_ bytes.
The second function removes 4 bytes, and stores them in the value _val32_,
after converting them from network-byte order (big-endian) to native
byte order.
== RETURN VALUES
This function returns 0 on success, and non-zero otherwise.
== ERRORS
`NNG_EINVAL`:: The message header is too short to remove the requested data.
== SEE ALSO
<<nng_msg_alloc.3#,nng_msg_alloc(3)>>,
<<nng_msg_header.3#,nng_msg_header(3)>>,
<<nng_msg_header_append.3#,nng_msg_header_append(3)>>,
<<nng_msg_header_chop.3#,nng_msg_header_chop(3)>>,
<<nng_msg_header_insert.3#,nng_msg_header_insert(3)>>,
<<nng_msg_header_len.3#,nng_msg_header_len(3)>>,
<<nng_msg_free.3#,nng_msg_free(3)>>,
<<nng_strerror.3#,nng_strerror(3)>>,
<<nng_msg.5#,nng_msg(5)>>,
<<nng.7#,nng(7)>>
|
