ip__address.html 12.6 KB
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ip::address</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../index.html" title="Asio">
<link rel="up" href="../reference.html" title="Reference">
<link rel="prev" href="io_service.html" title="io_service">
<link rel="next" href="ip__address/address.html" title="ip::address::address">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="io_service.html"><img src="../../prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../home.png" alt="Home"></a><a accesskey="n" href="ip__address/address.html"><img src="../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="asio.reference.ip__address"></a><a class="link" href="ip__address.html" title="ip::address">ip::address</a>
</h3></div></div></div>
<p>
        Implements version-independent IP addresses.
      </p>
<pre class="programlisting">class address
</pre>
<h5>
<a name="asio.reference.ip__address.h0"></a>
        <span><a name="asio.reference.ip__address.member_functions"></a></span><a class="link" href="ip__address.html#asio.reference.ip__address.member_functions">Member
        Functions</a>
      </h5>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                <p>
                  Name
                </p>
              </th>
<th>
                <p>
                  Description
                </p>
              </th>
</tr></thead>
<tbody>
<tr>
<td>
                <p>
                  <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>
                </p>
              </td>
<td>
                <p>
                  Default constructor. <br> <span class="silver"></span><br> Construct an address from an
                  IPv4 address. <br> <span class="silver"></span><br> Construct an address from an IPv6 address.
                  <br> <span class="silver"></span><br> Copy constructor.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <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>
                </p>
              </td>
<td>
                <p>
                  (Deprecated: Use make_address().) Create an address from an IPv4
                  address string in dotted decimal form, or from an IPv6 address
                  in hexadecimal notation.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="ip__address/is_loopback.html" title="ip::address::is_loopback"><span class="bold"><strong>is_loopback</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Determine whether the address is a loopback address.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="ip__address/is_multicast.html" title="ip::address::is_multicast"><span class="bold"><strong>is_multicast</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Determine whether the address is a multicast address.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="ip__address/is_unspecified.html" title="ip::address::is_unspecified"><span class="bold"><strong>is_unspecified</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Determine whether the address is unspecified.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="ip__address/is_v4.html" title="ip::address::is_v4"><span class="bold"><strong>is_v4</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Get whether the address is an IP version 4 address.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="ip__address/is_v6.html" title="ip::address::is_v6"><span class="bold"><strong>is_v6</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Get whether the address is an IP version 6 address.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="ip__address/operator_eq_.html" title="ip::address::operator="><span class="bold"><strong>operator=</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Assign from another address. <br> <span class="silver"></span><br> Assign from an IPv4
                  address. <br> <span class="silver"></span><br> Assign from an IPv6 address.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="ip__address/to_string.html" title="ip::address::to_string"><span class="bold"><strong>to_string</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Get the address as a string. <br> <span class="silver"></span><br> (Deprecated: Use other
                  overload.) Get the address as a string.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="ip__address/to_v4.html" title="ip::address::to_v4"><span class="bold"><strong>to_v4</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Get the address as an IP version 4 address.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="ip__address/to_v6.html" title="ip::address::to_v6"><span class="bold"><strong>to_v6</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Get the address as an IP version 6 address.
                </p>
              </td>
</tr>
</tbody>
</table></div>
<h5>
<a name="asio.reference.ip__address.h1"></a>
        <span><a name="asio.reference.ip__address.friends"></a></span><a class="link" href="ip__address.html#asio.reference.ip__address.friends">Friends</a>
      </h5>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                <p>
                  Name
                </p>
              </th>
<th>
                <p>
                  Description
                </p>
              </th>
</tr></thead>
<tbody>
<tr>
<td>
                <p>
                  <a class="link" href="ip__address/operator_not__eq_.html" title="ip::address::operator!="><span class="bold"><strong>operator!=</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Compare two addresses for inequality.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="ip__address/operator_lt_.html" title="ip::address::operator&lt;"><span class="bold"><strong>operator&lt;</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Compare addresses for ordering.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="ip__address/operator_lt__eq_.html" title="ip::address::operator&lt;="><span class="bold"><strong>operator&lt;=</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Compare addresses for ordering.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="ip__address/operator_eq__eq_.html" title="ip::address::operator=="><span class="bold"><strong>operator==</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Compare two addresses for equality.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="ip__address/operator_gt_.html" title="ip::address::operator&gt;"><span class="bold"><strong>operator&gt;</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Compare addresses for ordering.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="ip__address/operator_gt__eq_.html" title="ip::address::operator&gt;="><span class="bold"><strong>operator&gt;=</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Compare addresses for ordering.
                </p>
              </td>
</tr>
</tbody>
</table></div>
<h5>
<a name="asio.reference.ip__address.h2"></a>
        <span><a name="asio.reference.ip__address.related_functions"></a></span><a class="link" href="ip__address.html#asio.reference.ip__address.related_functions">Related
        Functions</a>
      </h5>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                <p>
                  Name
                </p>
              </th>
<th>
                <p>
                  Description
                </p>
              </th>
</tr></thead>
<tbody>
<tr>
<td>
                <p>
                  <a class="link" href="ip__address/make_address.html" title="ip::address::make_address"><span class="bold"><strong>make_address</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Create an address from an IPv4 address string in dotted decimal
                  form, or from an IPv6 address in hexadecimal notation.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <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>
                </p>
              </td>
<td>
                <p>
                  Output an address as a string.
                </p>
              </td>
</tr>
</tbody>
</table></div>
<p>
        The <a class="link" href="ip__address.html" title="ip::address"><code class="computeroutput">ip::address</code></a>
        class provides the ability to use either IP version 4 or version 6 addresses.
      </p>
<h5>
<a name="asio.reference.ip__address.h3"></a>
        <span><a name="asio.reference.ip__address.thread_safety"></a></span><a class="link" href="ip__address.html#asio.reference.ip__address.thread_safety">Thread
        Safety</a>
      </h5>
<p>
        <span class="emphasis"><em>Distinct</em></span> <span class="emphasis"><em>objects:</em></span> Safe.
      </p>
<p>
        <span class="emphasis"><em>Shared</em></span> <span class="emphasis"><em>objects:</em></span> Unsafe.
      </p>
<h5>
<a name="asio.reference.ip__address.h4"></a>
        <span><a name="asio.reference.ip__address.requirements"></a></span><a class="link" href="ip__address.html#asio.reference.ip__address.requirements">Requirements</a>
      </h5>
<p>
        <span class="emphasis"><em>Header: </em></span><code class="literal">asio/ip/address.hpp</code>
      </p>
<p>
        <span class="emphasis"><em>Convenience header: </em></span><code class="literal">asio.hpp</code>
      </p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M.
      Kohlhoff<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        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>)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="io_service.html"><img src="../../prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../home.png" alt="Home"></a><a accesskey="n" href="ip__address/address.html"><img src="../../next.png" alt="Next"></a>
</div>
</body>
</html>