doc/html/boost_asio/reference/ip__address.html

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