aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_msg.5.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.5.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.5.adoc')
-rw-r--r--docs/man/nng_msg.5.adoc64
1 files changed, 0 insertions, 64 deletions
diff --git a/docs/man/nng_msg.5.adoc b/docs/man/nng_msg.5.adoc
deleted file mode 100644
index 5044cf18..00000000
--- a/docs/man/nng_msg.5.adoc
+++ /dev/null
@@ -1,64 +0,0 @@
-= nng_msg(5)
-//
-// Copyright 2019 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 - message
-
-== SYNOPSIS
-
-[source, c]
-----
-#include <nng/nng.h>
-
-typedef struct nng_msg nng_msg;
-----
-
-== DESCRIPTION
-
-An `nng_msg` represents a single ((message)) sent between Scalability Protocols
-peers.
-Messages internally have a ((body)), containing the application supplied
-payload, and a ((header)), containing protocol specific routing and similar
-related information.
-
-TIP: Using message-oriented functions is a good way to reduce the likelihood
-of data copies and improve application performance.
-
-Messages are allocated using the xref:nng_msg_alloc.3.adoc[`nng_msg_alloc()`]
-function, and are deallocated using the xref:nng_msg_free.3.adoc[`nng_msg_free()`]
-function.
-
-In addition there are other functions used to access message contents,
-including adding data to either the beginning or end of the message,
-automatic data conversion, and removing data from the beginning or end.
-These functions are designed to try to avoid copying message contents
-by making use of scratch areas at the beginning and end of the message.
-
-== SEE ALSO
-
-[.text-left]
-xref:nng_aio_get_msg.3.adoc[nng_aio_get_msg(3)],
-xref:nng_aio_set_msg.3.adoc[nng_aio_set_msg(3)],
-xref:nng_msg_alloc.3.adoc[nng_msg_alloc(3)],
-xref:nng_msg_body.3.adoc[nng_msg_body(3)],
-xref:nng_msg_dup.3.adoc[nng_msg_dup(3)],
-xref:nng_msg_free.3.adoc[nng_msg_free(3)],
-xref:nng_msg_header.3.adoc[nng_msg_header(3)],
-xref:nng_msg_header_len.3.adoc[nng_msg_header_len(3)],
-xref:nng_msg_len.3.adoc[nng_msg_len(3)],
-xref:nng_msg_capacity.3.adoc[nng_msg_capacity(3)],
-xref:nng_msg_reserve.3.adoc[nng_msg_reserve(3)],
-xref:nng_msg_realloc.3.adoc[nng_msg_realloc(3)],
-xref:nng_recvmsg.3.adoc[nng_recvmsg(3)],
-xref:nng_sendmsg.3.adoc[nng_sendmsg(3)],
-xref:nng_strerror.3.adoc[nng_strerror(3)],
-xref:nng.7.adoc[nng(7)]