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_insert.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_insert.adoc')
| -rw-r--r-- | docs/nng_msg_header_insert.adoc | 53 |
1 files changed, 0 insertions, 53 deletions
diff --git a/docs/nng_msg_header_insert.adoc b/docs/nng_msg_header_insert.adoc deleted file mode 100644 index 4cc5016c..00000000 --- a/docs/nng_msg_header_insert.adoc +++ /dev/null @@ -1,53 +0,0 @@ -= nng_msg_header_insert(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_insert, nng_msg_header_insert_u32 - prepend to message header - -== SYNOPSIS - -[source, c] ------------ -#include <nng/nng.h> - -int nng_msg_header_insert(nng_msg *msg, const void *val, size_t size); -int nng_msg_header_insert_u32(nng_msg *msg, uint32_t val32); ------------ - -== DESCRIPTION - -The `nng_msg_header_insert()` and `nng_msg_header_insert_u32()` functions -prepend data to the front of the headers of message _msg_, reallocating -if necessary. -The first function prepends _size_ bytes, copying them from _val_. The -second function prepends the value _val32_ in network-byte order (big-endian). - -== RETURN VALUES - -This function returns 0 on success, and non-zero otherwise. - -== ERRORS - -`NNG_ENOMEM`:: Insufficient free memory exists. - -== SEE ALSO - -<<nng_msg_alloc#,nng_msg_alloc(3)>>, -<<nng_msg_header_append#,nng_msg_header_append(3)>>, -<<nng_msg_header_body#,nng_msg_header_body(3)>>, -<<nng_msg_header_chop#,nng_msg_header_chop(3)>>, -<<nng_msg_header_len#,nng_msg_header_len(3)>>, -<<nng_msg_header_trim#,nng_msg_header_trim(3)>>, -<<nng_msg_free#,nng_msg_free(3)>>, -<<nng_msg_realloc#,nng_msg_realloc(3)>>, -<<nng_strerror#,nng_strerror(3)>>, -<<nng#,nng(7)>> |