aboutsummaryrefslogtreecommitdiff
path: root/docs/nng_msg_insert.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2018-01-23 15:48:46 -0800
committerGarrett D'Amore <garrett@damore.org>2018-01-23 15:48:46 -0800
commitb2800c58d63dc1b53557ea9294b323c3b1f90dab (patch)
tree86404a3611af3730f8e431e7a97c0c03fc5d3afe /docs/nng_msg_insert.adoc
parent35e05eb93404be5bd2c6ae8000336486a2e26d05 (diff)
downloadnng-b2800c58d63dc1b53557ea9294b323c3b1f90dab.tar.gz
nng-b2800c58d63dc1b53557ea9294b323c3b1f90dab.tar.bz2
nng-b2800c58d63dc1b53557ea9294b323c3b1f90dab.zip
Add message handling man pages.
Note that we're also no longer overriding the source formatter or the icons for new pages, since we can supply that on the command line in the script that generates output.
Diffstat (limited to 'docs/nng_msg_insert.adoc')
-rw-r--r--docs/nng_msg_insert.adoc66
1 files changed, 66 insertions, 0 deletions
diff --git a/docs/nng_msg_insert.adoc b/docs/nng_msg_insert.adoc
new file mode 100644
index 00000000..5b4377f5
--- /dev/null
+++ b/docs/nng_msg_insert.adoc
@@ -0,0 +1,66 @@
+= nng_msg_insert(3)
+:doctype: manpage
+:manmanual: nng
+:mansource: nng
+:manvolnum: 3
+:copyright: Copyright 2018 Staysail Systems, Inc. <info@staysail.tech> \
+ Copyright 2018 Capitar IT Group BV <info@capitar.com> \
+ This software 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_insert, nng_msg_insert_u32 - prepend to message body
+
+== SYNOPSIS
+
+[source, c]
+-----------
+#include <nng/nng.h>
+
+int nng_msg_insert(nng_msg *msg, const void *val, size_t size);
+int nng_msg_insert(nng_msg *msg, uint32_t val32);
+-----------
+
+== DESCRIPTION
+
+The `nng_msg_insert()` and `nng_msg_insert_u32()` functions prepend data to
+the front of the body of message _msg_, reallocating it 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).
+
+TIP: This function makes use of pre-allocated "headroom" in the message if
+available, so it can often avoid performing any reallocation. Applications
+should use this instead of reallocating and copying message content themselves,
+in order to benefit from this capabilitiy.
+
+== 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_append#,nng_msg_append(3)>>,
+<<nng_msg_body#,nng_msg_body(3)>>,
+<<nng_msg_chop#,nng_msg_chop(3)>>,
+<<nng_msg_free#,nng_msg_free(3)>>,
+<<nng_msg_len#,nng_msg_len(3)>>,
+<<nng_msg_realloc#,nng_msg_realloc(3)>>,
+<<nng_msg_trim#,nng_msg_trim(3)>>,
+<<nng_strerror#,nng_strerror(3)>>,
+<<nng#,nng(7)>>
+
+== COPYRIGHT
+
+Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] +
+Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV]
+
+This document is supplied under the terms of the
+https://opensource.org/licenses/MIT[MIT License].