summaryrefslogtreecommitdiff
path: root/man/tip/nng_sockaddr_inproc.5.html
blob: 868e2afc06bcc5909522ee8640ac96f9d5c98943 (plain)
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
---
version: tip
layout: manpage_v2
title: nng_sockaddr_inproc(5)
---
<h1>nng_sockaddr_inproc(5)</h1>
<div class="sect1">
<h2 id="_name">NAME</h2>
<div class="sectionbody">
<div class="paragraph">
<p>nng_sockaddr_inproc - inproc socket address</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-k">enum</span><span class="tok-w"> </span><span class="tok-n">sockaddr_family</span><span class="tok-w"> </span><span class="tok-p">{</span>
<span class="tok-w">    </span><span class="tok-n">NNG_AF_INPROC</span><span class="tok-w"> </span><span class="tok-o">=</span><span class="tok-w"> </span><span class="tok-mi">1</span><span class="tok-p">,</span>
<span class="tok-p">};</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-p">{</span>
<span class="tok-w">    </span><span class="tok-kt">uint16_t</span><span class="tok-w"> </span><span class="tok-n">sa_family</span><span class="tok-p">;</span>
<span class="tok-w">    </span><span class="tok-kt">uint16_t</span><span class="tok-w"> </span><span class="tok-n">sa_name</span><span class="tok-p">[</span><span class="tok-mi">128</span><span class="tok-p">];</span>
<span class="tok-p">}</span><span class="tok-w"> </span><span class="tok-n">nng_sockaddr_inproc</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_sockaddr_inproc</code> is the flavor of <a href="nng_sockaddr.5.html"><code>nng_sockaddr</code></a>
used to represent addresses associated with intra-process communication
using the <a href="nng_inproc.7.html"><em>inproc</em></a> transport.</p>
</div>
<div class="paragraph">
<p>The following structure members are present:</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1"><code>sa_family</code></dt>
<dd>
<p>This field will always have the value <code>NNG_AF_INPROC</code>.</p>
</dd>
<dt class="hdlist1"><code>sa_name</code></dt>
<dd>
<p>This field holds an arbitrary C string, which is the name of the address.
The string must be <code>NUL</code> terminated, but no other restrictions exist.</p>
</dd>
</dl>
</div>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
In order to ensure maximum compatibility, applications should avoid
hard coding the size of the <code>sa_name</code> member explicitly, but use the
<code>sizeof</code> operator to determine its actual size at compile time.
Furthermore, the size is guaranteed to be at least 128.
</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_sockaddr.5.html">nng_sockaddr(5)</a>,
<a href="nng_inproc.7.html">nng_inproc(7)</a>
<a href="nng.7.html">nng(7)</a></p>
</div>
</div>
</div>