diff options
| author | Garrett D'Amore <garrett@damore.org> | 2020-01-23 23:48:47 -0800 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2020-01-23 23:48:47 -0800 |
| commit | 92a5808b86cf8fb11d5c29a48ec770800839be17 (patch) | |
| tree | 7ef3c4b9aab34ff1ab5c4af551edc6aae8150b9d /man/v1.2.1/nng_msg_realloc.3.html | |
| parent | 1cbb98e031c4e34b7cb45aac74ee92d128b398ae (diff) | |
| download | nng-92a5808b86cf8fb11d5c29a48ec770800839be17.tar.gz nng-92a5808b86cf8fb11d5c29a48ec770800839be17.tar.bz2 nng-92a5808b86cf8fb11d5c29a48ec770800839be17.zip | |
Publishing updates for v1.2.1
Diffstat (limited to 'man/v1.2.1/nng_msg_realloc.3.html')
| -rw-r--r-- | man/v1.2.1/nng_msg_realloc.3.html | 138 |
1 files changed, 138 insertions, 0 deletions
diff --git a/man/v1.2.1/nng_msg_realloc.3.html b/man/v1.2.1/nng_msg_realloc.3.html new file mode 100644 index 00000000..42c6e47e --- /dev/null +++ b/man/v1.2.1/nng_msg_realloc.3.html @@ -0,0 +1,138 @@ +--- +version: v1.2.1 +layout: refman +--- +<!DOCTYPE html> +<html lang="en"> +<head> +<meta charset="UTF-8"> +<meta http-equiv="X-UA-Compatible" content="IE=edge"> +<meta name="viewport" content="width=device-width, initial-scale=1.0"> +<meta name="generator" content="Asciidoctor 2.0.10"> +<title>nng_msg_realloc(3)</title> +<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"> +<link rel="stylesheet" href="./asciidoctor.css"> +<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css"> +</head> +<body class="manpage toc2 toc-left"> +<div id="header"> +<h1>nng_msg_realloc(3) Manual Page</h1> +<div id="toc" class="toc2"> +<div id="toctitle">Table of Contents</div> +<ul class="sectlevel1"> +<li><a href="#_synopsis">SYNOPSIS</a></li> +<li><a href="#_description">DESCRIPTION</a></li> +<li><a href="#_return_values">RETURN VALUES</a></li> +<li><a href="#_errors">ERRORS</a></li> +<li><a href="#_see_also">SEE ALSO</a></li> +</ul> +</div> +<h2 id="_name">NAME</h2> +<div class="sectionbody"> +<p>nng_msg_realloc - reallocate a message</p> +</div> +</div> +<div id="content"> +<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-cpf"><nng/nng.h></span><span class="tok-cp"></span> + +<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_realloc</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">,</span> <span class="tok-kt">size_t</span> <span class="tok-n">size</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>The <code>nng_msg_realloc()</code> function re-allocates a message so that it has +a body of length <em>size</em>. +This message attempts to avoid extra allocations, +and will reuse the existing memory when possible.</p> +</div> +<div class="admonitionblock tip"> +<table> +<tr> +<td class="icon"> +<i class="fa icon-tip" title="Tip"></i> +</td> +<td class="content"> +One way to further reduce message allocations is to allocate a message +larger than needed, then use this function or +<a href="nng_msg_chop.3.html"><code>nng_msg_chop()</code></a> 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 <a href="nng_msg_append.3.html"><code>nng_msg_append()</code></a> +no actual memory allocations need to take place. +</td> +</tr> +</table> +</div> +<div class="admonitionblock note"> +<table> +<tr> +<td class="icon"> +<i class="fa icon-note" title="Note"></i> +</td> +<td class="content"> +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. +</td> +</tr> +</table> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_return_values">RETURN VALUES</h2> +<div class="sectionbody"> +<div class="paragraph"> +<p>This function returns 0 on success, and non-zero otherwise.</p> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_errors">ERRORS</h2> +<div class="sectionbody"> +<div class="hdlist"> +<table> +<tr> +<td class="hdlist1"> +<code>NNG_ENOMEM</code> +</td> +<td class="hdlist2"> +<p>Insufficient free memory exists to reallocate a message.</p> +</td> +</tr> +</table> +</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_msg_alloc.3.html">nng_msg_alloc(3)</a>, +<a href="nng_msg_append.3.html">nng_msg_append(3)</a>, +<a href="nng_msg_body.3.html">nng_msg_body(3)</a>, +<a href="nng_msg_chop.3.html">nng_msg_chop(3)</a>, +<a href="nng_msg_free.3.html">nng_msg_free(3)</a>, +<a href="nng_msg_insert.3.html">nng_msg_insert(3)</a>, +<a href="nng_msg_len.3.html">nng_msg_len(3)</a>, +<a href="nng_msg_trim.3.html">nng_msg_trim(3)</a>, +<a href="nng_strerror.3.html">nng_strerror(3)</a>, +<a href="nng_msg.5.html">nng_msg(5)</a>, +<a href="nng.7.html">nng(7)</a></p> +</div> +</div> +</div> +</div> +<link rel="stylesheet" href="./pygments-default.css"> +</body> +</html>
\ No newline at end of file |