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

## NAME

nng_msg_header --- return message header

## SYNOPSIS

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

void *nng_msg_header(nng_msg *msg);
```

## DESCRIPTION

The `nng_msg_header()` function returns a pointer to the start of the {{i:header}}
content of the [message][msg] _msg_.

> [!NOTE]
> The message header contains protocol-specific header content. Most
> applications should not need to access this content, but it is available
> for [raw mode][raw] sockets.

> [!NOTE]
> The value returned by this is invalidated by a call to any of the
> functions that modify the message or the header content.

## RETURN VALUES

Pointer to start of message header.

## SEE ALSO

[nng_msg_alloc][nng_msg_alloc],
[nng_msg_body][nng_msg_body],
[nng_msg_free][nng_msg_free],
[nng_msg_header_append][nng_msg_header_append],
[nng_msg_header_chop][nng_msg_header_chop],
[nng_msg_header_insert][nng_msg_header_insert]
[nng_msg_header_len][nng_msg_header_len],
[nng_msg_header_trim][nng_msg_header_trim]

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