• 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_v6</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__address_v4_range.html" title="ip::address_v4_range">
10<link rel="next" href="ip__address_v6/address_v6.html" title="ip::address_v6::address_v6">
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__address_v4_range.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_v6/address_v6.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_v6"></a><a class="link" href="ip__address_v6.html" title="ip::address_v6">ip::address_v6</a>
28</h3></div></div></div>
29<p>
30        Implements IP version 6 style addresses.
31      </p>
32<pre class="programlisting">class address_v6
33</pre>
34<h5>
35<a name="boost_asio.reference.ip__address_v6.h0"></a>
36        <span class="phrase"><a name="boost_asio.reference.ip__address_v6.types"></a></span><a class="link" href="ip__address_v6.html#boost_asio.reference.ip__address_v6.types">Types</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><tr>
56<td>
57                <p>
58                  <a class="link" href="ip__address_v6/bytes_type.html" title="ip::address_v6::bytes_type"><span class="bold"><strong>bytes_type</strong></span></a>
59                </p>
60              </td>
61<td>
62                <p>
63                  The type used to represent an address as an array of bytes.
64                </p>
65              </td>
66</tr></tbody>
67</table></div>
68<h5>
69<a name="boost_asio.reference.ip__address_v6.h1"></a>
70        <span class="phrase"><a name="boost_asio.reference.ip__address_v6.member_functions"></a></span><a class="link" href="ip__address_v6.html#boost_asio.reference.ip__address_v6.member_functions">Member Functions</a>
71      </h5>
72<div class="informaltable"><table class="table">
73<colgroup>
74<col>
75<col>
76</colgroup>
77<thead><tr>
78<th>
79                <p>
80                  Name
81                </p>
82              </th>
83<th>
84                <p>
85                  Description
86                </p>
87              </th>
88</tr></thead>
89<tbody>
90<tr>
91<td>
92                <p>
93                  <a class="link" href="ip__address_v6/address_v6.html" title="ip::address_v6::address_v6"><span class="bold"><strong>address_v6</strong></span></a> <span class="silver">[constructor]</span>
94                </p>
95              </td>
96<td>
97                <p>
98                  Default constructor. <br> <span class="silver"> —</span><br> Construct an address from raw
99                  bytes and scope ID. <br> <span class="silver"> —</span><br> Copy constructor.
100                </p>
101              </td>
102</tr>
103<tr>
104<td>
105                <p>
106                  <a class="link" href="ip__address_v6/any.html" title="ip::address_v6::any"><span class="bold"><strong>any</strong></span></a> <span class="silver">[static]</span>
107                </p>
108              </td>
109<td>
110                <p>
111                  Obtain an address object that represents any address.
112                </p>
113              </td>
114</tr>
115<tr>
116<td>
117                <p>
118                  <a class="link" href="ip__address_v6/from_string.html" title="ip::address_v6::from_string"><span class="bold"><strong>from_string</strong></span></a> <span class="silver">[static]</span>
119                </p>
120              </td>
121<td>
122                <p>
123                  (Deprecated: Use make_address_v6().) Create an IPv6 address from
124                  an IP address string.
125                </p>
126              </td>
127</tr>
128<tr>
129<td>
130                <p>
131                  <a class="link" href="ip__address_v6/is_link_local.html" title="ip::address_v6::is_link_local"><span class="bold"><strong>is_link_local</strong></span></a>
132                </p>
133              </td>
134<td>
135                <p>
136                  Determine whether the address is link local.
137                </p>
138              </td>
139</tr>
140<tr>
141<td>
142                <p>
143                  <a class="link" href="ip__address_v6/is_loopback.html" title="ip::address_v6::is_loopback"><span class="bold"><strong>is_loopback</strong></span></a>
144                </p>
145              </td>
146<td>
147                <p>
148                  Determine whether the address is a loopback address.
149                </p>
150              </td>
151</tr>
152<tr>
153<td>
154                <p>
155                  <a class="link" href="ip__address_v6/is_multicast.html" title="ip::address_v6::is_multicast"><span class="bold"><strong>is_multicast</strong></span></a>
156                </p>
157              </td>
158<td>
159                <p>
160                  Determine whether the address is a multicast address.
161                </p>
162              </td>
163</tr>
164<tr>
165<td>
166                <p>
167                  <a class="link" href="ip__address_v6/is_multicast_global.html" title="ip::address_v6::is_multicast_global"><span class="bold"><strong>is_multicast_global</strong></span></a>
168                </p>
169              </td>
170<td>
171                <p>
172                  Determine whether the address is a global multicast address.
173                </p>
174              </td>
175</tr>
176<tr>
177<td>
178                <p>
179                  <a class="link" href="ip__address_v6/is_multicast_link_local.html" title="ip::address_v6::is_multicast_link_local"><span class="bold"><strong>is_multicast_link_local</strong></span></a>
180                </p>
181              </td>
182<td>
183                <p>
184                  Determine whether the address is a link-local multicast address.
185                </p>
186              </td>
187</tr>
188<tr>
189<td>
190                <p>
191                  <a class="link" href="ip__address_v6/is_multicast_node_local.html" title="ip::address_v6::is_multicast_node_local"><span class="bold"><strong>is_multicast_node_local</strong></span></a>
192                </p>
193              </td>
194<td>
195                <p>
196                  Determine whether the address is a node-local multicast address.
197                </p>
198              </td>
199</tr>
200<tr>
201<td>
202                <p>
203                  <a class="link" href="ip__address_v6/is_multicast_org_local.html" title="ip::address_v6::is_multicast_org_local"><span class="bold"><strong>is_multicast_org_local</strong></span></a>
204                </p>
205              </td>
206<td>
207                <p>
208                  Determine whether the address is a org-local multicast address.
209                </p>
210              </td>
211</tr>
212<tr>
213<td>
214                <p>
215                  <a class="link" href="ip__address_v6/is_multicast_site_local.html" title="ip::address_v6::is_multicast_site_local"><span class="bold"><strong>is_multicast_site_local</strong></span></a>
216                </p>
217              </td>
218<td>
219                <p>
220                  Determine whether the address is a site-local multicast address.
221                </p>
222              </td>
223</tr>
224<tr>
225<td>
226                <p>
227                  <a class="link" href="ip__address_v6/is_site_local.html" title="ip::address_v6::is_site_local"><span class="bold"><strong>is_site_local</strong></span></a>
228                </p>
229              </td>
230<td>
231                <p>
232                  Determine whether the address is site local.
233                </p>
234              </td>
235</tr>
236<tr>
237<td>
238                <p>
239                  <a class="link" href="ip__address_v6/is_unspecified.html" title="ip::address_v6::is_unspecified"><span class="bold"><strong>is_unspecified</strong></span></a>
240                </p>
241              </td>
242<td>
243                <p>
244                  Determine whether the address is unspecified.
245                </p>
246              </td>
247</tr>
248<tr>
249<td>
250                <p>
251                  <a class="link" href="ip__address_v6/is_v4_compatible.html" title="ip::address_v6::is_v4_compatible"><span class="bold"><strong>is_v4_compatible</strong></span></a>
252                </p>
253              </td>
254<td>
255                <p>
256                  (Deprecated: No replacement.) Determine whether the address is
257                  an IPv4-compatible address.
258                </p>
259              </td>
260</tr>
261<tr>
262<td>
263                <p>
264                  <a class="link" href="ip__address_v6/is_v4_mapped.html" title="ip::address_v6::is_v4_mapped"><span class="bold"><strong>is_v4_mapped</strong></span></a>
265                </p>
266              </td>
267<td>
268                <p>
269                  Determine whether the address is a mapped IPv4 address.
270                </p>
271              </td>
272</tr>
273<tr>
274<td>
275                <p>
276                  <a class="link" href="ip__address_v6/loopback.html" title="ip::address_v6::loopback"><span class="bold"><strong>loopback</strong></span></a> <span class="silver">[static]</span>
277                </p>
278              </td>
279<td>
280                <p>
281                  Obtain an address object that represents the loopback address.
282                </p>
283              </td>
284</tr>
285<tr>
286<td>
287                <p>
288                  <a class="link" href="ip__address_v6/operator_eq_.html" title="ip::address_v6::operator="><span class="bold"><strong>operator=</strong></span></a>
289                </p>
290              </td>
291<td>
292                <p>
293                  Assign from another address.
294                </p>
295              </td>
296</tr>
297<tr>
298<td>
299                <p>
300                  <a class="link" href="ip__address_v6/scope_id.html" title="ip::address_v6::scope_id"><span class="bold"><strong>scope_id</strong></span></a>
301                </p>
302              </td>
303<td>
304                <p>
305                  The scope ID of the address.
306                </p>
307              </td>
308</tr>
309<tr>
310<td>
311                <p>
312                  <a class="link" href="ip__address_v6/to_bytes.html" title="ip::address_v6::to_bytes"><span class="bold"><strong>to_bytes</strong></span></a>
313                </p>
314              </td>
315<td>
316                <p>
317                  Get the address in bytes, in network byte order.
318                </p>
319              </td>
320</tr>
321<tr>
322<td>
323                <p>
324                  <a class="link" href="ip__address_v6/to_string.html" title="ip::address_v6::to_string"><span class="bold"><strong>to_string</strong></span></a>
325                </p>
326              </td>
327<td>
328                <p>
329                  Get the address as a string. <br> <span class="silver"> —</span><br> (Deprecated: Use other
330                  overload.) Get the address as a string.
331                </p>
332              </td>
333</tr>
334<tr>
335<td>
336                <p>
337                  <a class="link" href="ip__address_v6/to_v4.html" title="ip::address_v6::to_v4"><span class="bold"><strong>to_v4</strong></span></a>
338                </p>
339              </td>
340<td>
341                <p>
342                  (Deprecated: Use make_address_v4().) Converts an IPv4-mapped or
343                  IPv4-compatible address to an IPv4 address.
344                </p>
345              </td>
346</tr>
347<tr>
348<td>
349                <p>
350                  <a class="link" href="ip__address_v6/v4_compatible.html" title="ip::address_v6::v4_compatible"><span class="bold"><strong>v4_compatible</strong></span></a> <span class="silver">[static]</span>
351                </p>
352              </td>
353<td>
354                <p>
355                  (Deprecated: No replacement.) Create an IPv4-compatible IPv6 address.
356                </p>
357              </td>
358</tr>
359<tr>
360<td>
361                <p>
362                  <a class="link" href="ip__address_v6/v4_mapped.html" title="ip::address_v6::v4_mapped"><span class="bold"><strong>v4_mapped</strong></span></a> <span class="silver">[static]</span>
363                </p>
364              </td>
365<td>
366                <p>
367                  (Deprecated: Use make_address_v6().) Create an IPv4-mapped IPv6
368                  address.
369                </p>
370              </td>
371</tr>
372</tbody>
373</table></div>
374<h5>
375<a name="boost_asio.reference.ip__address_v6.h2"></a>
376        <span class="phrase"><a name="boost_asio.reference.ip__address_v6.friends"></a></span><a class="link" href="ip__address_v6.html#boost_asio.reference.ip__address_v6.friends">Friends</a>
377      </h5>
378<div class="informaltable"><table class="table">
379<colgroup>
380<col>
381<col>
382</colgroup>
383<thead><tr>
384<th>
385                <p>
386                  Name
387                </p>
388              </th>
389<th>
390                <p>
391                  Description
392                </p>
393              </th>
394</tr></thead>
395<tbody>
396<tr>
397<td>
398                <p>
399                  <a class="link" href="ip__address_v6/operator_not__eq_.html" title="ip::address_v6::operator!="><span class="bold"><strong>operator!=</strong></span></a>
400                </p>
401              </td>
402<td>
403                <p>
404                  Compare two addresses for inequality.
405                </p>
406              </td>
407</tr>
408<tr>
409<td>
410                <p>
411                  <a class="link" href="ip__address_v6/operator_lt_.html" title="ip::address_v6::operator&lt;"><span class="bold"><strong>operator&lt;</strong></span></a>
412                </p>
413              </td>
414<td>
415                <p>
416                  Compare addresses for ordering.
417                </p>
418              </td>
419</tr>
420<tr>
421<td>
422                <p>
423                  <a class="link" href="ip__address_v6/operator_lt__eq_.html" title="ip::address_v6::operator&lt;="><span class="bold"><strong>operator&lt;=</strong></span></a>
424                </p>
425              </td>
426<td>
427                <p>
428                  Compare addresses for ordering.
429                </p>
430              </td>
431</tr>
432<tr>
433<td>
434                <p>
435                  <a class="link" href="ip__address_v6/operator_eq__eq_.html" title="ip::address_v6::operator=="><span class="bold"><strong>operator==</strong></span></a>
436                </p>
437              </td>
438<td>
439                <p>
440                  Compare two addresses for equality.
441                </p>
442              </td>
443</tr>
444<tr>
445<td>
446                <p>
447                  <a class="link" href="ip__address_v6/operator_gt_.html" title="ip::address_v6::operator&gt;"><span class="bold"><strong>operator&gt;</strong></span></a>
448                </p>
449              </td>
450<td>
451                <p>
452                  Compare addresses for ordering.
453                </p>
454              </td>
455</tr>
456<tr>
457<td>
458                <p>
459                  <a class="link" href="ip__address_v6/operator_gt__eq_.html" title="ip::address_v6::operator&gt;="><span class="bold"><strong>operator&gt;=</strong></span></a>
460                </p>
461              </td>
462<td>
463                <p>
464                  Compare addresses for ordering.
465                </p>
466              </td>
467</tr>
468</tbody>
469</table></div>
470<h5>
471<a name="boost_asio.reference.ip__address_v6.h3"></a>
472        <span class="phrase"><a name="boost_asio.reference.ip__address_v6.related_functions"></a></span><a class="link" href="ip__address_v6.html#boost_asio.reference.ip__address_v6.related_functions">Related Functions</a>
473      </h5>
474<div class="informaltable"><table class="table">
475<colgroup>
476<col>
477<col>
478</colgroup>
479<thead><tr>
480<th>
481                <p>
482                  Name
483                </p>
484              </th>
485<th>
486                <p>
487                  Description
488                </p>
489              </th>
490</tr></thead>
491<tbody>
492<tr>
493<td>
494                <p>
495                  <a class="link" href="ip__address_v6/make_address_v6.html" title="ip::address_v6::make_address_v6"><span class="bold"><strong>make_address_v6</strong></span></a>
496                </p>
497              </td>
498<td>
499                <p>
500                  Create an IPv6 address from raw bytes and scope ID.
501                </p>
502                <p>
503                  Create an IPv6 address from an IP address string.
504                </p>
505                <p>
506                  Createan IPv6 address from an IP address string.
507                </p>
508                <p>
509                  Create an IPv4-mapped IPv6 address from an IPv4 address.
510                </p>
511              </td>
512</tr>
513<tr>
514<td>
515                <p>
516                  <a class="link" href="ip__address_v6/make_network_v6.html" title="ip::address_v6::make_network_v6"><span class="bold"><strong>make_network_v6</strong></span></a>
517                </p>
518              </td>
519<td>
520                <p>
521                  Create an IPv6 network from an address and prefix length.
522                </p>
523              </td>
524</tr>
525<tr>
526<td>
527                <p>
528                  <a class="link" href="ip__address_v6/operator_lt__lt_.html" title="ip::address_v6::operator&lt;&lt;"><span class="bold"><strong>operator&lt;&lt;</strong></span></a>
529                </p>
530              </td>
531<td>
532                <p>
533                  Output an address as a string.
534                </p>
535                <p>
536                  Output a network as a string.
537                </p>
538              </td>
539</tr>
540</tbody>
541</table></div>
542<p>
543        The <a class="link" href="ip__address_v6.html" title="ip::address_v6"><code class="computeroutput">ip::address_v6</code></a>
544        class provides the ability to use and manipulate IP version 6 addresses.
545      </p>
546<h5>
547<a name="boost_asio.reference.ip__address_v6.h4"></a>
548        <span class="phrase"><a name="boost_asio.reference.ip__address_v6.thread_safety"></a></span><a class="link" href="ip__address_v6.html#boost_asio.reference.ip__address_v6.thread_safety">Thread
549        Safety</a>
550      </h5>
551<p>
552        <span class="emphasis"><em>Distinct</em></span> <span class="emphasis"><em>objects:</em></span> Safe.
553      </p>
554<p>
555        <span class="emphasis"><em>Shared</em></span> <span class="emphasis"><em>objects:</em></span> Unsafe.
556      </p>
557<h5>
558<a name="boost_asio.reference.ip__address_v6.h5"></a>
559        <span class="phrase"><a name="boost_asio.reference.ip__address_v6.requirements"></a></span><a class="link" href="ip__address_v6.html#boost_asio.reference.ip__address_v6.requirements">Requirements</a>
560      </h5>
561<p>
562        <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/ip/address_v6.hpp</code>
563      </p>
564<p>
565        <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code>
566      </p>
567</div>
568<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
569<td align="left"></td>
570<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M.
571      Kohlhoff<p>
572        Distributed under the Boost Software License, Version 1.0. (See accompanying
573        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>)
574      </p>
575</div></td>
576</tr></table>
577<hr>
578<div class="spirit-nav">
579<a accesskey="p" href="ip__address_v4_range.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_v6/address_v6.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
580</div>
581</body>
582</html>
583