• 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::address</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="io_service.html" title="io_service">
10<link rel="next" href="ip__address/address.html" title="ip::address::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="io_service.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__address/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__address"></a><a class="link" href="ip__address.html" title="ip::address">ip::address</a>
28</h3></div></div></div>
29<p>
30        Implements version-independent IP addresses.
31      </p>
32<pre class="programlisting">class address
33</pre>
34<h5>
35<a name="boost_asio.reference.ip__address.h0"></a>
36        <span class="phrase"><a name="boost_asio.reference.ip__address.member_functions"></a></span><a class="link" href="ip__address.html#boost_asio.reference.ip__address.member_functions">Member
37        Functions</a>
38      </h5>
39<div class="informaltable"><table class="table">
40<colgroup>
41<col>
42<col>
43</colgroup>
44<thead><tr>
45<th>
46                <p>
47                  Name
48                </p>
49              </th>
50<th>
51                <p>
52                  Description
53                </p>
54              </th>
55</tr></thead>
56<tbody>
57<tr>
58<td>
59                <p>
60                  <a class="link" href="ip__address/address.html" title="ip::address::address"><span class="bold"><strong>address</strong></span></a> <span class="silver">[constructor]</span>
61                </p>
62              </td>
63<td>
64                <p>
65                  Default constructor. <br> <span class="silver"> —</span><br> Construct an address from an
66                  IPv4 address. <br> <span class="silver"> —</span><br> Construct an address from an IPv6 address.
67                  <br> <span class="silver"> —</span><br> Copy constructor.
68                </p>
69              </td>
70</tr>
71<tr>
72<td>
73                <p>
74                  <a class="link" href="ip__address/from_string.html" title="ip::address::from_string"><span class="bold"><strong>from_string</strong></span></a> <span class="silver">[static]</span>
75                </p>
76              </td>
77<td>
78                <p>
79                  (Deprecated: Use make_address().) Create an address from an IPv4
80                  address string in dotted decimal form, or from an IPv6 address
81                  in hexadecimal notation.
82                </p>
83              </td>
84</tr>
85<tr>
86<td>
87                <p>
88                  <a class="link" href="ip__address/is_loopback.html" title="ip::address::is_loopback"><span class="bold"><strong>is_loopback</strong></span></a>
89                </p>
90              </td>
91<td>
92                <p>
93                  Determine whether the address is a loopback address.
94                </p>
95              </td>
96</tr>
97<tr>
98<td>
99                <p>
100                  <a class="link" href="ip__address/is_multicast.html" title="ip::address::is_multicast"><span class="bold"><strong>is_multicast</strong></span></a>
101                </p>
102              </td>
103<td>
104                <p>
105                  Determine whether the address is a multicast address.
106                </p>
107              </td>
108</tr>
109<tr>
110<td>
111                <p>
112                  <a class="link" href="ip__address/is_unspecified.html" title="ip::address::is_unspecified"><span class="bold"><strong>is_unspecified</strong></span></a>
113                </p>
114              </td>
115<td>
116                <p>
117                  Determine whether the address is unspecified.
118                </p>
119              </td>
120</tr>
121<tr>
122<td>
123                <p>
124                  <a class="link" href="ip__address/is_v4.html" title="ip::address::is_v4"><span class="bold"><strong>is_v4</strong></span></a>
125                </p>
126              </td>
127<td>
128                <p>
129                  Get whether the address is an IP version 4 address.
130                </p>
131              </td>
132</tr>
133<tr>
134<td>
135                <p>
136                  <a class="link" href="ip__address/is_v6.html" title="ip::address::is_v6"><span class="bold"><strong>is_v6</strong></span></a>
137                </p>
138              </td>
139<td>
140                <p>
141                  Get whether the address is an IP version 6 address.
142                </p>
143              </td>
144</tr>
145<tr>
146<td>
147                <p>
148                  <a class="link" href="ip__address/operator_eq_.html" title="ip::address::operator="><span class="bold"><strong>operator=</strong></span></a>
149                </p>
150              </td>
151<td>
152                <p>
153                  Assign from another address. <br> <span class="silver"> —</span><br> Assign from an IPv4
154                  address. <br> <span class="silver"> —</span><br> Assign from an IPv6 address.
155                </p>
156              </td>
157</tr>
158<tr>
159<td>
160                <p>
161                  <a class="link" href="ip__address/to_string.html" title="ip::address::to_string"><span class="bold"><strong>to_string</strong></span></a>
162                </p>
163              </td>
164<td>
165                <p>
166                  Get the address as a string. <br> <span class="silver"> —</span><br> (Deprecated: Use other
167                  overload.) Get the address as a string.
168                </p>
169              </td>
170</tr>
171<tr>
172<td>
173                <p>
174                  <a class="link" href="ip__address/to_v4.html" title="ip::address::to_v4"><span class="bold"><strong>to_v4</strong></span></a>
175                </p>
176              </td>
177<td>
178                <p>
179                  Get the address as an IP version 4 address.
180                </p>
181              </td>
182</tr>
183<tr>
184<td>
185                <p>
186                  <a class="link" href="ip__address/to_v6.html" title="ip::address::to_v6"><span class="bold"><strong>to_v6</strong></span></a>
187                </p>
188              </td>
189<td>
190                <p>
191                  Get the address as an IP version 6 address.
192                </p>
193              </td>
194</tr>
195</tbody>
196</table></div>
197<h5>
198<a name="boost_asio.reference.ip__address.h1"></a>
199        <span class="phrase"><a name="boost_asio.reference.ip__address.friends"></a></span><a class="link" href="ip__address.html#boost_asio.reference.ip__address.friends">Friends</a>
200      </h5>
201<div class="informaltable"><table class="table">
202<colgroup>
203<col>
204<col>
205</colgroup>
206<thead><tr>
207<th>
208                <p>
209                  Name
210                </p>
211              </th>
212<th>
213                <p>
214                  Description
215                </p>
216              </th>
217</tr></thead>
218<tbody>
219<tr>
220<td>
221                <p>
222                  <a class="link" href="ip__address/operator_not__eq_.html" title="ip::address::operator!="><span class="bold"><strong>operator!=</strong></span></a>
223                </p>
224              </td>
225<td>
226                <p>
227                  Compare two addresses for inequality.
228                </p>
229              </td>
230</tr>
231<tr>
232<td>
233                <p>
234                  <a class="link" href="ip__address/operator_lt_.html" title="ip::address::operator&lt;"><span class="bold"><strong>operator&lt;</strong></span></a>
235                </p>
236              </td>
237<td>
238                <p>
239                  Compare addresses for ordering.
240                </p>
241              </td>
242</tr>
243<tr>
244<td>
245                <p>
246                  <a class="link" href="ip__address/operator_lt__eq_.html" title="ip::address::operator&lt;="><span class="bold"><strong>operator&lt;=</strong></span></a>
247                </p>
248              </td>
249<td>
250                <p>
251                  Compare addresses for ordering.
252                </p>
253              </td>
254</tr>
255<tr>
256<td>
257                <p>
258                  <a class="link" href="ip__address/operator_eq__eq_.html" title="ip::address::operator=="><span class="bold"><strong>operator==</strong></span></a>
259                </p>
260              </td>
261<td>
262                <p>
263                  Compare two addresses for equality.
264                </p>
265              </td>
266</tr>
267<tr>
268<td>
269                <p>
270                  <a class="link" href="ip__address/operator_gt_.html" title="ip::address::operator&gt;"><span class="bold"><strong>operator&gt;</strong></span></a>
271                </p>
272              </td>
273<td>
274                <p>
275                  Compare addresses for ordering.
276                </p>
277              </td>
278</tr>
279<tr>
280<td>
281                <p>
282                  <a class="link" href="ip__address/operator_gt__eq_.html" title="ip::address::operator&gt;="><span class="bold"><strong>operator&gt;=</strong></span></a>
283                </p>
284              </td>
285<td>
286                <p>
287                  Compare addresses for ordering.
288                </p>
289              </td>
290</tr>
291</tbody>
292</table></div>
293<h5>
294<a name="boost_asio.reference.ip__address.h2"></a>
295        <span class="phrase"><a name="boost_asio.reference.ip__address.related_functions"></a></span><a class="link" href="ip__address.html#boost_asio.reference.ip__address.related_functions">Related
296        Functions</a>
297      </h5>
298<div class="informaltable"><table class="table">
299<colgroup>
300<col>
301<col>
302</colgroup>
303<thead><tr>
304<th>
305                <p>
306                  Name
307                </p>
308              </th>
309<th>
310                <p>
311                  Description
312                </p>
313              </th>
314</tr></thead>
315<tbody>
316<tr>
317<td>
318                <p>
319                  <a class="link" href="ip__address/make_address.html" title="ip::address::make_address"><span class="bold"><strong>make_address</strong></span></a>
320                </p>
321              </td>
322<td>
323                <p>
324                  Create an address from an IPv4 address string in dotted decimal
325                  form, or from an IPv6 address in hexadecimal notation.
326                </p>
327              </td>
328</tr>
329<tr>
330<td>
331                <p>
332                  <a class="link" href="ip__address/operator_lt__lt_.html" title="ip::address::operator&lt;&lt;"><span class="bold"><strong>operator&lt;&lt;</strong></span></a>
333                </p>
334              </td>
335<td>
336                <p>
337                  Output an address as a string.
338                </p>
339              </td>
340</tr>
341</tbody>
342</table></div>
343<p>
344        The <a class="link" href="ip__address.html" title="ip::address"><code class="computeroutput">ip::address</code></a>
345        class provides the ability to use either IP version 4 or version 6 addresses.
346      </p>
347<h5>
348<a name="boost_asio.reference.ip__address.h3"></a>
349        <span class="phrase"><a name="boost_asio.reference.ip__address.thread_safety"></a></span><a class="link" href="ip__address.html#boost_asio.reference.ip__address.thread_safety">Thread
350        Safety</a>
351      </h5>
352<p>
353        <span class="emphasis"><em>Distinct</em></span> <span class="emphasis"><em>objects:</em></span> Safe.
354      </p>
355<p>
356        <span class="emphasis"><em>Shared</em></span> <span class="emphasis"><em>objects:</em></span> Unsafe.
357      </p>
358<h5>
359<a name="boost_asio.reference.ip__address.h4"></a>
360        <span class="phrase"><a name="boost_asio.reference.ip__address.requirements"></a></span><a class="link" href="ip__address.html#boost_asio.reference.ip__address.requirements">Requirements</a>
361      </h5>
362<p>
363        <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/ip/address.hpp</code>
364      </p>
365<p>
366        <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code>
367      </p>
368</div>
369<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
370<td align="left"></td>
371<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M.
372      Kohlhoff<p>
373        Distributed under the Boost Software License, Version 1.0. (See accompanying
374        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>)
375      </p>
376</div></td>
377</tr></table>
378<hr>
379<div class="spirit-nav">
380<a accesskey="p" href="io_service.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__address/address.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
381</div>
382</body>
383</html>
384