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