• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>ip::network_v4</title>
5<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
7<link rel="home" href="../../boost_asio.html" title="Boost.Asio">
8<link rel="up" href="../reference.html" title="Reference">
9<link rel="prev" href="ip__multicast__outbound_interface.html" title="ip::multicast::outbound_interface">
10<link rel="next" href="ip__network_v4/address.html" title="ip::network_v4::address">
11</head>
12<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
13<table cellpadding="2" width="100%"><tr>
14<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
15<td align="center"><a href="../../../../index.html">Home</a></td>
16<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
17<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
18<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
19<td align="center"><a href="../../../../more/index.htm">More</a></td>
20</tr></table>
21<hr>
22<div class="spirit-nav">
23<a accesskey="p" href="ip__multicast__outbound_interface.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../boost_asio.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="ip__network_v4/address.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
24</div>
25<div class="section">
26<div class="titlepage"><div><div><h3 class="title">
27<a name="boost_asio.reference.ip__network_v4"></a><a class="link" href="ip__network_v4.html" title="ip::network_v4">ip::network_v4</a>
28</h3></div></div></div>
29<p>
30        Represents an IPv4 network.
31      </p>
32<pre class="programlisting">class network_v4
33</pre>
34<h5>
35<a name="boost_asio.reference.ip__network_v4.h0"></a>
36        <span class="phrase"><a name="boost_asio.reference.ip__network_v4.member_functions"></a></span><a class="link" href="ip__network_v4.html#boost_asio.reference.ip__network_v4.member_functions">Member Functions</a>
37      </h5>
38<div class="informaltable"><table class="table">
39<colgroup>
40<col>
41<col>
42</colgroup>
43<thead><tr>
44<th>
45                <p>
46                  Name
47                </p>
48              </th>
49<th>
50                <p>
51                  Description
52                </p>
53              </th>
54</tr></thead>
55<tbody>
56<tr>
57<td>
58                <p>
59                  <a class="link" href="ip__network_v4/address.html" title="ip::network_v4::address"><span class="bold"><strong>address</strong></span></a>
60                </p>
61              </td>
62<td>
63                <p>
64                  Obtain the address object specified when the network object was
65                  created.
66                </p>
67              </td>
68</tr>
69<tr>
70<td>
71                <p>
72                  <a class="link" href="ip__network_v4/broadcast.html" title="ip::network_v4::broadcast"><span class="bold"><strong>broadcast</strong></span></a>
73                </p>
74              </td>
75<td>
76                <p>
77                  Obtain an address object that represents the network's broadcast
78                  address.
79                </p>
80              </td>
81</tr>
82<tr>
83<td>
84                <p>
85                  <a class="link" href="ip__network_v4/canonical.html" title="ip::network_v4::canonical"><span class="bold"><strong>canonical</strong></span></a>
86                </p>
87              </td>
88<td>
89                <p>
90                  Obtain the true network address, omitting any host bits.
91                </p>
92              </td>
93</tr>
94<tr>
95<td>
96                <p>
97                  <a class="link" href="ip__network_v4/hosts.html" title="ip::network_v4::hosts"><span class="bold"><strong>hosts</strong></span></a>
98                </p>
99              </td>
100<td>
101                <p>
102                  Obtain an address range corresponding to the hosts in the network.
103                </p>
104              </td>
105</tr>
106<tr>
107<td>
108                <p>
109                  <a class="link" href="ip__network_v4/is_host.html" title="ip::network_v4::is_host"><span class="bold"><strong>is_host</strong></span></a>
110                </p>
111              </td>
112<td>
113                <p>
114                  Test if network is a valid host address.
115                </p>
116              </td>
117</tr>
118<tr>
119<td>
120                <p>
121                  <a class="link" href="ip__network_v4/is_subnet_of.html" title="ip::network_v4::is_subnet_of"><span class="bold"><strong>is_subnet_of</strong></span></a>
122                </p>
123              </td>
124<td>
125                <p>
126                  Test if a network is a real subnet of another network.
127                </p>
128              </td>
129</tr>
130<tr>
131<td>
132                <p>
133                  <a class="link" href="ip__network_v4/netmask.html" title="ip::network_v4::netmask"><span class="bold"><strong>netmask</strong></span></a>
134                </p>
135              </td>
136<td>
137                <p>
138                  Obtain the netmask that was specified when the network object was
139                  created.
140                </p>
141              </td>
142</tr>
143<tr>
144<td>
145                <p>
146                  <a class="link" href="ip__network_v4/network.html" title="ip::network_v4::network"><span class="bold"><strong>network</strong></span></a>
147                </p>
148              </td>
149<td>
150                <p>
151                  Obtain an address object that represents the network address.
152                </p>
153              </td>
154</tr>
155<tr>
156<td>
157                <p>
158                  <a class="link" href="ip__network_v4/network_v4.html" title="ip::network_v4::network_v4"><span class="bold"><strong>network_v4</strong></span></a> <span class="silver">[constructor]</span>
159                </p>
160              </td>
161<td>
162                <p>
163                  Default constructor. <br> <span class="silver"> —</span><br> Construct a network based on
164                  the specified address and prefix length. <br> <span class="silver"> —</span><br> Construct
165                  network based on the specified address and netmask. <br> <span class="silver"> —</span><br>
166                  Copy constructor.
167                </p>
168              </td>
169</tr>
170<tr>
171<td>
172                <p>
173                  <a class="link" href="ip__network_v4/operator_eq_.html" title="ip::network_v4::operator="><span class="bold"><strong>operator=</strong></span></a>
174                </p>
175              </td>
176<td>
177                <p>
178                  Assign from another network.
179                </p>
180              </td>
181</tr>
182<tr>
183<td>
184                <p>
185                  <a class="link" href="ip__network_v4/prefix_length.html" title="ip::network_v4::prefix_length"><span class="bold"><strong>prefix_length</strong></span></a>
186                </p>
187              </td>
188<td>
189                <p>
190                  Obtain the prefix length that was specified when the network object
191                  was created.
192                </p>
193              </td>
194</tr>
195<tr>
196<td>
197                <p>
198                  <a class="link" href="ip__network_v4/to_string.html" title="ip::network_v4::to_string"><span class="bold"><strong>to_string</strong></span></a>
199                </p>
200              </td>
201<td>
202                <p>
203                  Get the network as an address in dotted decimal format.
204                </p>
205              </td>
206</tr>
207</tbody>
208</table></div>
209<h5>
210<a name="boost_asio.reference.ip__network_v4.h1"></a>
211        <span class="phrase"><a name="boost_asio.reference.ip__network_v4.friends"></a></span><a class="link" href="ip__network_v4.html#boost_asio.reference.ip__network_v4.friends">Friends</a>
212      </h5>
213<div class="informaltable"><table class="table">
214<colgroup>
215<col>
216<col>
217</colgroup>
218<thead><tr>
219<th>
220                <p>
221                  Name
222                </p>
223              </th>
224<th>
225                <p>
226                  Description
227                </p>
228              </th>
229</tr></thead>
230<tbody>
231<tr>
232<td>
233                <p>
234                  <a class="link" href="ip__network_v4/operator_not__eq_.html" title="ip::network_v4::operator!="><span class="bold"><strong>operator!=</strong></span></a>
235                </p>
236              </td>
237<td>
238                <p>
239                  Compare two networks for inequality.
240                </p>
241              </td>
242</tr>
243<tr>
244<td>
245                <p>
246                  <a class="link" href="ip__network_v4/operator_eq__eq_.html" title="ip::network_v4::operator=="><span class="bold"><strong>operator==</strong></span></a>
247                </p>
248              </td>
249<td>
250                <p>
251                  Compare two networks for equality.
252                </p>
253              </td>
254</tr>
255</tbody>
256</table></div>
257<h5>
258<a name="boost_asio.reference.ip__network_v4.h2"></a>
259        <span class="phrase"><a name="boost_asio.reference.ip__network_v4.related_functions"></a></span><a class="link" href="ip__network_v4.html#boost_asio.reference.ip__network_v4.related_functions">Related Functions</a>
260      </h5>
261<div class="informaltable"><table class="table">
262<colgroup>
263<col>
264<col>
265</colgroup>
266<thead><tr>
267<th>
268                <p>
269                  Name
270                </p>
271              </th>
272<th>
273                <p>
274                  Description
275                </p>
276              </th>
277</tr></thead>
278<tbody><tr>
279<td>
280                <p>
281                  <a class="link" href="ip__network_v4/make_network_v4.html" title="ip::network_v4::make_network_v4"><span class="bold"><strong>make_network_v4</strong></span></a>
282                </p>
283              </td>
284<td>
285                <p>
286                  Create an IPv4 network from a string containing IP address and
287                  prefix length.
288                </p>
289              </td>
290</tr></tbody>
291</table></div>
292<p>
293        The <a class="link" href="ip__network_v4.html" title="ip::network_v4"><code class="computeroutput">ip::network_v4</code></a>
294        class provides the ability to use and manipulate IP version 4 networks.
295      </p>
296<h5>
297<a name="boost_asio.reference.ip__network_v4.h3"></a>
298        <span class="phrase"><a name="boost_asio.reference.ip__network_v4.thread_safety"></a></span><a class="link" href="ip__network_v4.html#boost_asio.reference.ip__network_v4.thread_safety">Thread
299        Safety</a>
300      </h5>
301<p>
302        <span class="emphasis"><em>Distinct</em></span> <span class="emphasis"><em>objects:</em></span> Safe.
303      </p>
304<p>
305        <span class="emphasis"><em>Shared</em></span> <span class="emphasis"><em>objects:</em></span> Unsafe.
306      </p>
307<h5>
308<a name="boost_asio.reference.ip__network_v4.h4"></a>
309        <span class="phrase"><a name="boost_asio.reference.ip__network_v4.requirements"></a></span><a class="link" href="ip__network_v4.html#boost_asio.reference.ip__network_v4.requirements">Requirements</a>
310      </h5>
311<p>
312        <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/ip/network_v4.hpp</code>
313      </p>
314<p>
315        <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code>
316      </p>
317</div>
318<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
319<td align="left"></td>
320<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M.
321      Kohlhoff<p>
322        Distributed under the Boost Software License, Version 1.0. (See accompanying
323        file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
324      </p>
325</div></td>
326</tr></table>
327<hr>
328<div class="spirit-nav">
329<a accesskey="p" href="ip__multicast__outbound_interface.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../boost_asio.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="ip__network_v4/address.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
330</div>
331</body>
332</html>
333