man/tip/nng_stream_free.3str.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99

---
version: tip
layout: manpage_v2
title: nng_stream_free(3str)
---
<h1>nng_stream_free(3str)</h1>
<div class="sect1">
<h2 id="_name">NAME</h2>
<div class="sectionbody">
<div class="paragraph">
<p>nng_stream_free - free byte stream</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">&lt;nng/nng.h&gt;</span>

<span class="tok-kt">void</span><span class="tok-w"> </span><span class="tok-nf">nng_stream_free</span><span class="tok-p">(</span><span class="tok-n">nng_stream</span><span class="tok-w"> </span><span class="tok-o">*</span><span class="tok-n">s</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_stream_free()</code> function closes the
<a href="nng_stream.5.html">byte stream</a> <em>s</em>,
and frees the underlying resources associated with it.</p>
</div>
<div class="paragraph">
<p>If any operations are pending, such as
<a href="nng_stream_send.3str.html"><code>nng_stream_send()</code></a>
or
<a href="nng_stream_recv.3str.html"><code>nng_stream_recv()</code></a>,
they will be terminated with an <code>NNG_ECLOSED</code> error condition.</p>
</div>
<div class="admonitionblock warning">
<table>
<tr>
<td class="icon">
<i class="fa icon-warning" title="Warning"></i>
</td>
<td class="content">
It is important that the application ensure that no further accesses
are made to <em>s</em>, as the memory backing it will be reclaimed for other uses.
</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">
Closing the connection while data is in transmission will likely
lead to loss of that data.
There is no automatic linger or flush to ensure that the socket send buffers
have completely transmitted.
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_return_values">RETURN VALUES</h2>
<div class="sectionbody">
<div class="paragraph">
<p>None.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_errors">ERRORS</h2>
<div class="sectionbody">
<div class="paragraph">
<p>None.</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_strerror.3.html">nng_strerror(3)</a>,
<a href="nng_stream_close.3str.html">nng_stream_close(3str)</a>,
<a href="nng_stream_recv.3str.html">nng_stream_recv(3str)</a>,
<a href="nng_stream_send.3str.html">nng_stream_send(3str)</a>,
<a href="nng_stream.5.html">nng_stream(5)</a></p>
</div>
</div>
</div>