diff options
| author | Staysail Systems, Inc. <info@staysail.tech> | 2024-04-21 12:37:34 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2024-04-21 12:42:38 -0700 |
| commit | 306f54bfff5b7ecac660a652e3ca17e5d226c6ff (patch) | |
| tree | 3ee6571ddb9143dab08d8b9f830bc46bc77c9bf9 /man/v1.8.0/nng_msg.5.html | |
| parent | 397cf9c1fa26b9efb10cef3b89acdc597b164753 (diff) | |
| download | nng-306f54bfff5b7ecac660a652e3ca17e5d226c6ff.tar.gz nng-306f54bfff5b7ecac660a652e3ca17e5d226c6ff.tar.bz2 nng-306f54bfff5b7ecac660a652e3ca17e5d226c6ff.zip | |
Manual page updates for v1.8.0
Diffstat (limited to 'man/v1.8.0/nng_msg.5.html')
| -rw-r--r-- | man/v1.8.0/nng_msg.5.html | 86 |
1 files changed, 86 insertions, 0 deletions
diff --git a/man/v1.8.0/nng_msg.5.html b/man/v1.8.0/nng_msg.5.html new file mode 100644 index 00000000..8e27464f --- /dev/null +++ b/man/v1.8.0/nng_msg.5.html @@ -0,0 +1,86 @@ +--- +version: v1.8.0 +layout: manpage_v2 +title: nng_msg(5) +--- +<h1>nng_msg(5)</h1> +<div class="sect1"> +<h2 id="_name">NAME</h2> +<div class="sectionbody"> +<div class="paragraph"> +<p>nng_msg - message</p> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_synopsis">SYNOPSIS</h2> +<div class="sectionbody"> +<div class="listingblock"> +<div class="content"> +<pre class="pygments highlight"><code data-lang="c"><span></span><span class="tok-cp">#include</span><span class="tok-w"> </span><span class="tok-cpf"><nng/nng.h></span> + +<span class="tok-k">typedef</span><span class="tok-w"> </span><span class="tok-k">struct</span><span class="tok-w"> </span><span class="tok-nc">nng_msg</span><span class="tok-w"> </span><span class="tok-n">nng_msg</span><span class="tok-p">;</span></code></pre> +</div> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_description">DESCRIPTION</h2> +<div class="sectionbody"> +<div class="paragraph"> +<p>An <code>nng_msg</code> 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.</p> +</div> +<div class="admonitionblock tip"> +<table> +<tr> +<td class="icon"> +<i class="fa icon-tip" title="Tip"></i> +</td> +<td class="content"> +Using message-oriented functions is a good way to reduce the likelihood +of data copies and improve application performance. +</td> +</tr> +</table> +</div> +<div class="paragraph"> +<p>Messages are allocated using the <a href="nng_msg_alloc.3.html"><code>nng_msg_alloc()</code></a> +function, and are deallocated using the <a href="nng_msg_free.3.html"><code>nng_msg_free()</code></a> +function.</p> +</div> +<div class="paragraph"> +<p>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.</p> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_see_also">SEE ALSO</h2> +<div class="sectionbody"> +<div class="paragraph text-left"> +<p><a href="nng_aio_get_msg.3.html">nng_aio_get_msg(3)</a>, +<a href="nng_aio_set_msg.3.html">nng_aio_set_msg(3)</a>, +<a href="nng_msg_alloc.3.html">nng_msg_alloc(3)</a>, +<a href="nng_msg_body.3.html">nng_msg_body(3)</a>, +<a href="nng_msg_dup.3.html">nng_msg_dup(3)</a>, +<a href="nng_msg_free.3.html">nng_msg_free(3)</a>, +<a href="nng_msg_header.3.html">nng_msg_header(3)</a>, +<a href="nng_msg_header_len.3.html">nng_msg_header_len(3)</a>, +<a href="nng_msg_len.3.html">nng_msg_len(3)</a>, +<a href="nng_msg_capacity.3.html">nng_msg_capacity(3)</a>, +<a href="nng_msg_reserve.3.html">nng_msg_reserve(3)</a>, +<a href="nng_msg_realloc.3.html">nng_msg_realloc(3)</a>, +<a href="nng_recvmsg.3.html">nng_recvmsg(3)</a>, +<a href="nng_sendmsg.3.html">nng_sendmsg(3)</a>, +<a href="nng_strerror.3.html">nng_strerror(3)</a>, +<a href="nng.7.html">nng(7)</a></p> +</div> +</div> +</div> |
