diff options
| author | Garrett D'Amore <garrett@damore.org> | 2018-02-25 17:56:55 -0800 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2018-02-25 17:56:55 -0800 |
| commit | 87795b46f2bc732bd11067805709161bdc00d6b6 (patch) | |
| tree | 892f3bcea1a14df5dde8dba413d394f5ccb0a0e0 /docs/nng_msg_header.adoc | |
| parent | 545942f7ace7cde8a1b8a6a5289cecc185b08fbc (diff) | |
| download | nng-87795b46f2bc732bd11067805709161bdc00d6b6.tar.gz nng-87795b46f2bc732bd11067805709161bdc00d6b6.tar.bz2 nng-87795b46f2bc732bd11067805709161bdc00d6b6.zip | |
More man page reorganization.
Man pages need special handling, and we can have other kinds of documentation
like initial starting guides, etc., which would have different processing
applied. So lets move them off into their own directory.
Diffstat (limited to 'docs/nng_msg_header.adoc')
| -rw-r--r-- | docs/nng_msg_header.adoc | 56 |
1 files changed, 0 insertions, 56 deletions
diff --git a/docs/nng_msg_header.adoc b/docs/nng_msg_header.adoc deleted file mode 100644 index 7d85db5e..00000000 --- a/docs/nng_msg_header.adoc +++ /dev/null @@ -1,56 +0,0 @@ -= nng_msg_header(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 - return message header - -== SYNOPSIS - -[source, 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 header -content of the message _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 sockets (set with the `NNG_OPT_RAW` option -- see -<<nng_setopt#,nng_setopt(3)>> for more details.) - -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. - -== ERRORS - -None. - -== SEE ALSO - -<<nng_msg_alloc#,nng_msg_alloc(3)>>, -<<nng_msg_body#,nng_msg_body(3)>>, -<<nng_msg_free#,nng_msg_free(3)>>, -<<nng_msg_header_append#,nng_msg_header_append(3)>>, -<<nng_msg_header_chop#,nng_msg_header_chop(3)>>, -<<nng_msg_header_insert#,nng_msg_header_insert(3)>> -<<nng_msg_header_len#,nng_msg_header_len(3)>>, -<<nng_msg_header_trim#,nng_msg_header_trim(3)>>, -<<nng#,nng(7)>> |