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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
|
---
version: tip
layout: manpage_v2
title: nng_ctx_recvmsg(3)
---
<h1>nng_ctx_recvmsg(3)</h1>
<div class="sect1">
<h2 id="_name">NAME</h2>
<div class="sectionbody">
<div class="paragraph">
<p>nng_ctx_recvmsg - receive message using socket</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-kt">int</span><span class="tok-w"> </span><span class="tok-nf">nng_ctx_recvmsg</span><span class="tok-p">(</span><span class="tok-n">nng_ctx</span><span class="tok-w"> </span><span class="tok-n">ctx</span><span class="tok-p">,</span><span class="tok-w"> </span><span class="tok-n">nng_msg</span><span class="tok-w"> </span><span class="tok-o">**</span><span class="tok-n">msgp</span><span class="tok-p">,</span><span class="tok-w"> </span><span class="tok-kt">int</span><span class="tok-w"> </span><span class="tok-n">flags</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_ctx_recvmsg()</code> receives a message on context <em>ctx</em>, storing the
received message at the location pointed to by <em>msgp</em>.</p>
</div>
<div class="paragraph">
<p>The <em>flags</em> may contain the following value:</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1"><code>NNG_FLAG_NONBLOCK</code></dt>
<dd>
<p>The function returns immediately, even if no message is available.
Without this flag, the function will wait until a message is receivable
on the context <em>ctx</em>, or any configured timer expires.</p>
</dd>
</dl>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
The semantics of what receiving a message means vary from protocol to
protocol, so examination of the protocol documentation is encouraged.
</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_EAGAIN</code>
</td>
<td class="hdlist2">
<p>The operation would block, but <code>NNG_FLAG_NONBLOCK</code> was specified.</p>
</td>
</tr>
<tr>
<td class="hdlist1">
<code>NNG_ECLOSED</code>
</td>
<td class="hdlist2">
<p>The context or socket is not open.</p>
</td>
</tr>
<tr>
<td class="hdlist1">
<code>NNG_EINVAL</code>
</td>
<td class="hdlist2">
<p>An invalid set of <em>flags</em> was specified.</p>
</td>
</tr>
<tr>
<td class="hdlist1">
<code>NNG_ENOMEM</code>
</td>
<td class="hdlist2">
<p>Insufficient memory is available.</p>
</td>
</tr>
<tr>
<td class="hdlist1">
<code>NNG_ENOTSUP</code>
</td>
<td class="hdlist2">
<p>The protocol does not support receiving.</p>
</td>
</tr>
<tr>
<td class="hdlist1">
<code>NNG_ESTATE</code>
</td>
<td class="hdlist2">
<p>The context cannot receive data in this state.</p>
</td>
</tr>
<tr>
<td class="hdlist1">
<code>NNG_ETIMEDOUT</code>
</td>
<td class="hdlist2">
<p>The operation timed out.</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_free.3.html">nng_msg_free(3)</a>,
<a href="nng_ctx_open.3.html">nng_ctx_open(3)</a>,
<a href="nng_ctx_recv.3.html">nng_ctx_recv(3)</a>,
<a href="nng_ctx_sendmsg.3.html">nng_ctx_sendmsg(3)</a>,
<a href="nng_strerror.3.html">nng_strerror(3)</a>,
<a href="nng_ctx.5.html">nng_ctx(5)</a>,
<a href="nng.7.html">nng(7)</a></p>
</div>
</div>
</div>
|
