boost/doc/html/boost_asio/reference/ip__basic_resolver_results.html
2021-10-05 21:37:46 +02:00

578 lines
21 KiB
HTML

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ip::basic_resolver_results</title>
<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../boost_asio.html" title="Boost.Asio">
<link rel="up" href="../reference.html" title="Reference">
<link rel="prev" href="ip__basic_resolver_query/v4_mapped.html" title="ip::basic_resolver_query::v4_mapped">
<link rel="next" href="ip__basic_resolver_results/basic_resolver_results.html" title="ip::basic_resolver_results::basic_resolver_results">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="ip__basic_resolver_query/v4_mapped.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__basic_resolver_results/basic_resolver_results.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_asio.reference.ip__basic_resolver_results"></a><a class="link" href="ip__basic_resolver_results.html" title="ip::basic_resolver_results">ip::basic_resolver_results</a>
</h3></div></div></div>
<p>
<a class="indexterm" name="boost_asio.indexterm.ip__basic_resolver_results"></a>
</p>
<p>
A range of entries produced by a resolver.
</p>
<pre class="programlisting">template&lt;
typename <a class="link" href="InternetProtocol.html" title="Internet protocol requirements">InternetProtocol</a>&gt;
class basic_resolver_results :
public ip::basic_resolver_iterator&lt; InternetProtocol &gt;
</pre>
<h5>
<a name="boost_asio.reference.ip__basic_resolver_results.h0"></a>
<span class="phrase"><a name="boost_asio.reference.ip__basic_resolver_results.types"></a></span><a class="link" href="ip__basic_resolver_results.html#boost_asio.reference.ip__basic_resolver_results.types">Types</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__basic_resolver_results/const_iterator.html" title="ip::basic_resolver_results::const_iterator"><span class="bold"><strong>const_iterator</strong></span></a>
</p>
</td>
<td>
<p>
The type of an iterator into the range.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ip__basic_resolver_results/const_reference.html" title="ip::basic_resolver_results::const_reference"><span class="bold"><strong>const_reference</strong></span></a>
</p>
</td>
<td>
<p>
The type of a const reference to a value in the range.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ip__basic_resolver_results/difference_type.html" title="ip::basic_resolver_results::difference_type"><span class="bold"><strong>difference_type</strong></span></a>
</p>
</td>
<td>
<p>
Type used to represent the distance between two iterators in the
range.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ip__basic_resolver_results/endpoint_type.html" title="ip::basic_resolver_results::endpoint_type"><span class="bold"><strong>endpoint_type</strong></span></a>
</p>
</td>
<td>
<p>
The endpoint type associated with the results.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ip__basic_resolver_results/iterator.html" title="ip::basic_resolver_results::iterator"><span class="bold"><strong>iterator</strong></span></a>
</p>
</td>
<td>
<p>
The type of an iterator into the range.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ip__basic_resolver_results/iterator_category.html" title="ip::basic_resolver_results::iterator_category"><span class="bold"><strong>iterator_category</strong></span></a>
</p>
</td>
<td>
<p>
The iterator category.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ip__basic_resolver_results/pointer.html" title="ip::basic_resolver_results::pointer"><span class="bold"><strong>pointer</strong></span></a>
</p>
</td>
<td>
<p>
The type of the result of applying operator-&gt;() to the iterator.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ip__basic_resolver_results/protocol_type.html" title="ip::basic_resolver_results::protocol_type"><span class="bold"><strong>protocol_type</strong></span></a>
</p>
</td>
<td>
<p>
The protocol type associated with the results.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ip__basic_resolver_results/reference.html" title="ip::basic_resolver_results::reference"><span class="bold"><strong>reference</strong></span></a>
</p>
</td>
<td>
<p>
The type of a non-const reference to a value in the range.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ip__basic_resolver_results/size_type.html" title="ip::basic_resolver_results::size_type"><span class="bold"><strong>size_type</strong></span></a>
</p>
</td>
<td>
<p>
Type used to represent a count of the elements in the range.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ip__basic_resolver_results/value_type.html" title="ip::basic_resolver_results::value_type"><span class="bold"><strong>value_type</strong></span></a>
</p>
</td>
<td>
<p>
The type of a value in the results range.
</p>
</td>
</tr>
</tbody>
</table></div>
<h5>
<a name="boost_asio.reference.ip__basic_resolver_results.h1"></a>
<span class="phrase"><a name="boost_asio.reference.ip__basic_resolver_results.member_functions"></a></span><a class="link" href="ip__basic_resolver_results.html#boost_asio.reference.ip__basic_resolver_results.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__basic_resolver_results/basic_resolver_results.html" title="ip::basic_resolver_results::basic_resolver_results"><span class="bold"><strong>basic_resolver_results</strong></span></a> <span class="silver">[constructor]</span>
</p>
</td>
<td>
<p>
Default constructor creates an empty range. <br> <span class="silver"></span><br> Copy
constructor. <br> <span class="silver"></span><br> Move constructor.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ip__basic_resolver_results/begin.html" title="ip::basic_resolver_results::begin"><span class="bold"><strong>begin</strong></span></a>
</p>
</td>
<td>
<p>
Obtain a begin iterator for the results range.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ip__basic_resolver_results/cbegin.html" title="ip::basic_resolver_results::cbegin"><span class="bold"><strong>cbegin</strong></span></a>
</p>
</td>
<td>
<p>
Obtain a begin iterator for the results range.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ip__basic_resolver_results/cend.html" title="ip::basic_resolver_results::cend"><span class="bold"><strong>cend</strong></span></a>
</p>
</td>
<td>
<p>
Obtain an end iterator for the results range.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ip__basic_resolver_results/empty.html" title="ip::basic_resolver_results::empty"><span class="bold"><strong>empty</strong></span></a>
</p>
</td>
<td>
<p>
Determine whether the results range is empty.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ip__basic_resolver_results/end.html" title="ip::basic_resolver_results::end"><span class="bold"><strong>end</strong></span></a>
</p>
</td>
<td>
<p>
Obtain an end iterator for the results range.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ip__basic_resolver_results/max_size.html" title="ip::basic_resolver_results::max_size"><span class="bold"><strong>max_size</strong></span></a>
</p>
</td>
<td>
<p>
Get the maximum number of entries permitted in a results range.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ip__basic_resolver_results/operator__star_.html" title="ip::basic_resolver_results::operator *"><span class="bold"><strong>operator *</strong></span></a>
</p>
</td>
<td>
<p>
Dereference an iterator.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ip__basic_resolver_results/operator_plus__plus_.html" title="ip::basic_resolver_results::operator++"><span class="bold"><strong>operator++</strong></span></a>
</p>
</td>
<td>
<p>
Increment operator (prefix). <br> <span class="silver"></span><br> Increment operator (postfix).
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ip__basic_resolver_results/operator_arrow_.html" title="ip::basic_resolver_results::operator-&gt;"><span class="bold"><strong>operator-&gt;</strong></span></a>
</p>
</td>
<td>
<p>
Dereference an iterator.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ip__basic_resolver_results/operator_eq_.html" title="ip::basic_resolver_results::operator="><span class="bold"><strong>operator=</strong></span></a>
</p>
</td>
<td>
<p>
Assignment operator. <br> <span class="silver"></span><br> Move-assignment operator.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ip__basic_resolver_results/size.html" title="ip::basic_resolver_results::size"><span class="bold"><strong>size</strong></span></a>
</p>
</td>
<td>
<p>
Get the number of entries in the results range.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ip__basic_resolver_results/swap.html" title="ip::basic_resolver_results::swap"><span class="bold"><strong>swap</strong></span></a>
</p>
</td>
<td>
<p>
Swap the results range with another.
</p>
</td>
</tr>
</tbody>
</table></div>
<h5>
<a name="boost_asio.reference.ip__basic_resolver_results.h2"></a>
<span class="phrase"><a name="boost_asio.reference.ip__basic_resolver_results.protected_member_functions"></a></span><a class="link" href="ip__basic_resolver_results.html#boost_asio.reference.ip__basic_resolver_results.protected_member_functions">Protected
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__basic_resolver_results/dereference.html" title="ip::basic_resolver_results::dereference"><span class="bold"><strong>dereference</strong></span></a>
</p>
</td>
<td>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ip__basic_resolver_results/equal.html" title="ip::basic_resolver_results::equal"><span class="bold"><strong>equal</strong></span></a>
</p>
</td>
<td>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ip__basic_resolver_results/increment.html" title="ip::basic_resolver_results::increment"><span class="bold"><strong>increment</strong></span></a>
</p>
</td>
<td>
</td>
</tr>
</tbody>
</table></div>
<h5>
<a name="boost_asio.reference.ip__basic_resolver_results.h3"></a>
<span class="phrase"><a name="boost_asio.reference.ip__basic_resolver_results.protected_data_members"></a></span><a class="link" href="ip__basic_resolver_results.html#boost_asio.reference.ip__basic_resolver_results.protected_data_members">Protected
Data Members</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__basic_resolver_results/index_.html" title="ip::basic_resolver_results::index_"><span class="bold"><strong>index_</strong></span></a>
</p>
</td>
<td>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ip__basic_resolver_results/values_.html" title="ip::basic_resolver_results::values_"><span class="bold"><strong>values_</strong></span></a>
</p>
</td>
<td>
</td>
</tr>
</tbody>
</table></div>
<h5>
<a name="boost_asio.reference.ip__basic_resolver_results.h4"></a>
<span class="phrase"><a name="boost_asio.reference.ip__basic_resolver_results.friends"></a></span><a class="link" href="ip__basic_resolver_results.html#boost_asio.reference.ip__basic_resolver_results.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__basic_resolver_results/operator_not__eq_.html" title="ip::basic_resolver_results::operator!="><span class="bold"><strong>operator!=</strong></span></a>
</p>
</td>
<td>
<p>
Test two iterators for inequality.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ip__basic_resolver_results/operator_eq__eq_.html" title="ip::basic_resolver_results::operator=="><span class="bold"><strong>operator==</strong></span></a>
</p>
</td>
<td>
<p>
Test two iterators for equality.
</p>
</td>
</tr>
</tbody>
</table></div>
<p>
The <a class="link" href="ip__basic_resolver_results.html" title="ip::basic_resolver_results"><code class="computeroutput">ip::basic_resolver_results</code></a>
class template is used to define a range over the results returned by a resolver.
</p>
<p>
The iterator's value_type, obtained when a results iterator is dereferenced,
is:
</p>
<pre class="programlisting">const basic_resolver_entry&lt;InternetProtocol&gt;
</pre>
<h5>
<a name="boost_asio.reference.ip__basic_resolver_results.h5"></a>
<span class="phrase"><a name="boost_asio.reference.ip__basic_resolver_results.remarks"></a></span><a class="link" href="ip__basic_resolver_results.html#boost_asio.reference.ip__basic_resolver_results.remarks">Remarks</a>
</h5>
<p>
For backward compatibility, <a class="link" href="ip__basic_resolver_results.html" title="ip::basic_resolver_results"><code class="computeroutput">ip::basic_resolver_results</code></a>
is derived from <a class="link" href="ip__basic_resolver_iterator.html" title="ip::basic_resolver_iterator"><code class="computeroutput">ip::basic_resolver_iterator</code></a>.
This derivation is deprecated.
</p>
<h5>
<a name="boost_asio.reference.ip__basic_resolver_results.h6"></a>
<span class="phrase"><a name="boost_asio.reference.ip__basic_resolver_results.thread_safety"></a></span><a class="link" href="ip__basic_resolver_results.html#boost_asio.reference.ip__basic_resolver_results.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="boost_asio.reference.ip__basic_resolver_results.h7"></a>
<span class="phrase"><a name="boost_asio.reference.ip__basic_resolver_results.requirements"></a></span><a class="link" href="ip__basic_resolver_results.html#boost_asio.reference.ip__basic_resolver_results.requirements">Requirements</a>
</h5>
<p>
<span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/ip/basic_resolver_results.hpp</code>
</p>
<p>
<span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/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-2021 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="ip__basic_resolver_query/v4_mapped.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__basic_resolver_results/basic_resolver_results.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>