aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_msg_header_append.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2018-02-25 17:56:55 -0800
committerGarrett D'Amore <garrett@damore.org>2018-02-25 17:56:55 -0800
commit87795b46f2bc732bd11067805709161bdc00d6b6 (patch)
tree892f3bcea1a14df5dde8dba413d394f5ccb0a0e0 /docs/man/nng_msg_header_append.adoc
parent545942f7ace7cde8a1b8a6a5289cecc185b08fbc (diff)
downloadnng-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/man/nng_msg_header_append.adoc')
-rw-r--r--docs/man/nng_msg_header_append.adoc53
1 files changed, 53 insertions, 0 deletions
diff --git a/docs/man/nng_msg_header_append.adoc b/docs/man/nng_msg_header_append.adoc
new file mode 100644
index 00000000..a21da6dc
--- /dev/null
+++ b/docs/man/nng_msg_header_append.adoc
@@ -0,0 +1,53 @@
+= nng_msg_header_append(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_append, nng_msg_header_append_u32 - append to message header
+
+== SYNOPSIS
+
+[source, c]
+-----------
+#include <nng/nng.h>
+
+int nng_msg_header_append(nng_msg *msg, const void *val, size_t size);
+int nng_msg_header_append_u32(nng_msg *msg, uint32_t val32);
+-----------
+
+== DESCRIPTION
+
+The `nng_msg_header_append()` and `nng_msg_header_append_u32()`
+functions append data to
+the end of the headers of message _msg_, reallocating it if necessary.
+The first function appends _size_ bytes, copying them from _val_. The
+second function appends 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#,nng_msg_header(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_msg_free#,nng_msg_free(3)>>,
+<<nng_strerror#,nng_strerror(3)>>,
+<<nng#,nng(7)>>