From b2800c58d63dc1b53557ea9294b323c3b1f90dab Mon Sep 17 00:00:00 2001
From: Garrett D'Amore <garrett@damore.org>
Date: Tue, 23 Jan 2018 15:48:46 -0800
Subject: 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.
---
 docs/nng_msg_realloc.adoc | 70 +++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 70 insertions(+)
 create mode 100644 docs/nng_msg_realloc.adoc

(limited to 'docs/nng_msg_realloc.adoc')

diff --git a/docs/nng_msg_realloc.adoc b/docs/nng_msg_realloc.adoc
new file mode 100644
index 00000000..3693eca2
--- /dev/null
+++ b/docs/nng_msg_realloc.adoc
@@ -0,0 +1,70 @@
+= nng_msg_alloc(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_alloc - allocate a message
+
+== SYNOPSIS
+
+[source, c]
+-----------
+#include <nng/nng.h>
+
+int nng_msg_realloc(nng_msg *msg, size_t size);
+-----------
+
+== DESCRIPTION
+
+The `nng_msg_realloc()` function re-allocates a message so that it has
+a body of length _size_.  This message attempts to avoid extra allocations,
+and will reuse the existing memory when possible.
+
+TIP: One way to further reduce message allocations is to allocate a message
+larger than needed, then use this function or <<nng_msg_chop#,nng_msg_chop(3)>>
+to reduce the message size to that actually needed.  The extra space left
+over will still be present in the message, so that when the message size
+needs to grow due to this function or <<nng_msg_append#,nng_msg_append(3)>>
+no actual memory allocations need to take place.
+
+NOTE: Pointers to message body and header content obtained prior to this
+function must not be in use, as the underlying memory used for the message
+may have changed, particularly if the message size is increasing.
+
+== RETURN VALUES
+
+This function returns 0 on success, and non-zero otherwise.
+
+== ERRORS
+
+`NNG_ENOMEM`:: Insufficient free memory exists to reallocate a message.
+
+== 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_insert#,nng_msg_insert(3)>>,
+<<nng_msg_len#,nng_msg_len(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].
-- 
cgit v1.2.3-70-g09d2

