aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_msg_capacity.3.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2024-10-12 11:36:52 -0700
committerGarrett D'Amore <garrett@damore.org>2024-10-12 11:36:52 -0700
commitf26952c3bcbc83358e3a69d5d2e613f61fd657e1 (patch)
treeafbbe30788e933169bb3779e6cecd694e5537f2a /docs/man/nng_msg_capacity.3.adoc
parent522293fc3c121af6189bdca0b4285c03118d9cd6 (diff)
downloadnng-f26952c3bcbc83358e3a69d5d2e613f61fd657e1.tar.gz
nng-f26952c3bcbc83358e3a69d5d2e613f61fd657e1.tar.bz2
nng-f26952c3bcbc83358e3a69d5d2e613f61fd657e1.zip
nng_msg docs converted to mdbook
We're moving to fewer man pages, with related functions grouped together in the same man page, and this continues the trend.
Diffstat (limited to 'docs/man/nng_msg_capacity.3.adoc')
-rw-r--r--docs/man/nng_msg_capacity.3.adoc46
1 files changed, 0 insertions, 46 deletions
diff --git a/docs/man/nng_msg_capacity.3.adoc b/docs/man/nng_msg_capacity.3.adoc
deleted file mode 100644
index ffc7f5d3..00000000
--- a/docs/man/nng_msg_capacity.3.adoc
+++ /dev/null
@@ -1,46 +0,0 @@
-= nng_msg_capacity(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_capacity - return message body length
-
-== SYNOPSIS
-
-[source, c]
-----
-#include <nng/nng.h>
-
-size_t nng_msg_capacity(nng_msg *msg);
-----
-
-== DESCRIPTION
-
-The `nng_msg_capacity()` returns the storage allocated for the body of message _msg_.
-The capacity includes the current contents of the message and free space after it.
-The message body may grow to capacity without performing any further allocations.
-
-== RETURN VALUES
-
-Allocated capacity for message body.
-
-== ERRORS
-
-None.
-
-== SEE ALSO
-
-[.text-left]
-xref:nng_msg_reserve.3.adoc[nng_msg_reserve(3)],
-xref:nng_msg_alloc.3.adoc[nng_msg_alloc(3)],
-xref:nng_msg_body.3.adoc[nng_msg_body(3)],
-xref:nng_msg.5.adoc[nng_msg(5)],
-xref:nng.7.adoc[nng(7)]