/doc/asio/reference/ip__basic_resolver_query.html
HTML | 317 lines | 317 code | 0 blank | 0 comment | 0 complexity | 07c6e2c3669a416c0bb5b3c5a643f294 MD5 | raw file
- <html>
- <head>
- <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
- <title>ip::basic_resolver_query</title>
- <link rel="stylesheet" href="../../boostbook.css" type="text/css">
- <meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
- <link rel="start" href="../../index.html" title="Asio">
- <link rel="up" href="../reference.html" title="Reference">
- <link rel="prev" href="ip__basic_resolver_iterator/operator_eq__eq_.html" title="ip::basic_resolver_iterator::operator==">
- <link rel="next" href="ip__basic_resolver_query/address_configured.html" title="ip::basic_resolver_query::address_configured">
- </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="ip__basic_resolver_iterator/operator_eq__eq_.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__basic_resolver_query/address_configured.html"><img src="../../next.png" alt="Next"></a>
- </div>
- <div class="section" lang="en">
- <div class="titlepage"><div><div><h3 class="title">
- <a name="asio.reference.ip__basic_resolver_query"></a><a class="link" href="ip__basic_resolver_query.html" title="ip::basic_resolver_query">ip::basic_resolver_query</a>
- </h3></div></div></div>
- <p>
- An query to be passed to a resolver.
- </p>
- <pre class="programlisting"><span class="keyword">template</span><span class="special"><</span>
- <span class="keyword">typename</span> <a class="link" href="InternetProtocol.html" title="Internet protocol requirements">InternetProtocol</a><span class="special">></span>
- <span class="keyword">class</span> <span class="identifier">basic_resolver_query</span> <span class="special">:</span>
- <span class="keyword">public</span> <span class="identifier">ip</span><span class="special">::</span><span class="identifier">resolver_query_base</span>
- </pre>
- <a name="asio.reference.ip__basic_resolver_query.types"></a><h5>
- <a name="id1098460"></a>
- <a class="link" href="ip__basic_resolver_query.html#asio.reference.ip__basic_resolver_query.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_query/flags.html" title="ip::basic_resolver_query::flags"><span class="bold"><strong>flags</strong></span></a>
- </p>
- </td>
- <td>
- <p>
- A bitmask type (C++ Std [lib.bitmask.types]).
- </p>
- </td>
- </tr>
- <tr>
- <td>
- <p>
- <a class="link" href="ip__basic_resolver_query/protocol_type.html" title="ip::basic_resolver_query::protocol_type"><span class="bold"><strong>protocol_type</strong></span></a>
- </p>
- </td>
- <td>
- <p>
- The protocol type associated with the endpoint query.
- </p>
- </td>
- </tr>
- </tbody>
- </table></div>
- <a name="asio.reference.ip__basic_resolver_query.member_functions"></a><h5>
- <a name="id1098568"></a>
- <a class="link" href="ip__basic_resolver_query.html#asio.reference.ip__basic_resolver_query.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_query/basic_resolver_query.html" title="ip::basic_resolver_query::basic_resolver_query"><span class="bold"><strong>basic_resolver_query</strong></span></a>
- </p>
- </td>
- <td>
- <p>
- Construct with specified service name for any protocol.
- </p>
- <p>
- Construct with specified service name for a given protocol.
- </p>
- <p>
- Construct with specified host name and service name for any protocol.
- </p>
- <p>
- Construct with specified host name and service name for a given
- protocol.
- </p>
- </td>
- </tr>
- <tr>
- <td>
- <p>
- <a class="link" href="ip__basic_resolver_query/hints.html" title="ip::basic_resolver_query::hints"><span class="bold"><strong>hints</strong></span></a>
- </p>
- </td>
- <td>
- <p>
- Get the hints associated with the query.
- </p>
- </td>
- </tr>
- <tr>
- <td>
- <p>
- <a class="link" href="ip__basic_resolver_query/host_name.html" title="ip::basic_resolver_query::host_name"><span class="bold"><strong>host_name</strong></span></a>
- </p>
- </td>
- <td>
- <p>
- Get the host name associated with the query.
- </p>
- </td>
- </tr>
- <tr>
- <td>
- <p>
- <a class="link" href="ip__basic_resolver_query/service_name.html" title="ip::basic_resolver_query::service_name"><span class="bold"><strong>service_name</strong></span></a>
- </p>
- </td>
- <td>
- <p>
- Get the service name associated with the query.
- </p>
- </td>
- </tr>
- </tbody>
- </table></div>
- <a name="asio.reference.ip__basic_resolver_query.data_members"></a><h5>
- <a name="id1098744"></a>
- <a class="link" href="ip__basic_resolver_query.html#asio.reference.ip__basic_resolver_query.data_members">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_query/address_configured.html" title="ip::basic_resolver_query::address_configured"><span class="bold"><strong>address_configured</strong></span></a>
- </p>
- </td>
- <td>
- <p>
- Only return IPv4 addresses if a non-loopback IPv4 address is configured
- for the system. Only return IPv6 addresses if a non-loopback IPv6
- address is configured for the system.
- </p>
- </td>
- </tr>
- <tr>
- <td>
- <p>
- <a class="link" href="ip__basic_resolver_query/all_matching.html" title="ip::basic_resolver_query::all_matching"><span class="bold"><strong>all_matching</strong></span></a>
- </p>
- </td>
- <td>
- <p>
- If used with v4_mapped, return all matching IPv6 and IPv4 addresses.
- </p>
- </td>
- </tr>
- <tr>
- <td>
- <p>
- <a class="link" href="ip__basic_resolver_query/canonical_name.html" title="ip::basic_resolver_query::canonical_name"><span class="bold"><strong>canonical_name</strong></span></a>
- </p>
- </td>
- <td>
- <p>
- Determine the canonical name of the host specified in the query.
- </p>
- </td>
- </tr>
- <tr>
- <td>
- <p>
- <a class="link" href="ip__basic_resolver_query/numeric_host.html" title="ip::basic_resolver_query::numeric_host"><span class="bold"><strong>numeric_host</strong></span></a>
- </p>
- </td>
- <td>
- <p>
- Host name should be treated as a numeric string defining an IPv4
- or IPv6 address and no name resolution should be attempted.
- </p>
- </td>
- </tr>
- <tr>
- <td>
- <p>
- <a class="link" href="ip__basic_resolver_query/numeric_service.html" title="ip::basic_resolver_query::numeric_service"><span class="bold"><strong>numeric_service</strong></span></a>
- </p>
- </td>
- <td>
- <p>
- Service name should be treated as a numeric string defining a port
- number and no name resolution should be attempted.
- </p>
- </td>
- </tr>
- <tr>
- <td>
- <p>
- <a class="link" href="ip__basic_resolver_query/passive.html" title="ip::basic_resolver_query::passive"><span class="bold"><strong>passive</strong></span></a>
- </p>
- </td>
- <td>
- <p>
- Indicate that returned endpoint is intended for use as a locally
- bound socket endpoint.
- </p>
- </td>
- </tr>
- <tr>
- <td>
- <p>
- <a class="link" href="ip__basic_resolver_query/v4_mapped.html" title="ip::basic_resolver_query::v4_mapped"><span class="bold"><strong>v4_mapped</strong></span></a>
- </p>
- </td>
- <td>
- <p>
- If the query protocol family is specified as IPv6, return IPv4-mapped
- IPv6 addresses on finding no IPv6 addresses.
- </p>
- </td>
- </tr>
- </tbody>
- </table></div>
- <p>
- The <a class="link" href="ip__basic_resolver_query.html" title="ip::basic_resolver_query"><code class="computeroutput"><span class="identifier">ip</span><span class="special">::</span><span class="identifier">basic_resolver_query</span></code></a>
- class template describes a query that can be passed to a resolver.
- </p>
- <a name="asio.reference.ip__basic_resolver_query.thread_safety"></a><h5>
- <a name="id1099022"></a>
- <a class="link" href="ip__basic_resolver_query.html#asio.reference.ip__basic_resolver_query.thread_safety">Thread
- Safety</a>
- </h5>
- <p>
- <span class="bold"><strong>Distinct</strong></span> <span class="bold"><strong>objects:</strong></span>
- Safe.
- </p>
- <p>
- <span class="bold"><strong>Shared</strong></span> <span class="bold"><strong>objects:</strong></span>
- Unsafe.
- </p>
- <a name="asio.reference.ip__basic_resolver_query.requirements"></a><h5>
- <a name="id1099072"></a>
- <a class="link" href="ip__basic_resolver_query.html#asio.reference.ip__basic_resolver_query.requirements">Requirements</a>
- </h5>
- <p>
- <span class="bold"><strong>Header: </strong></span><code class="literal">asio/ip/basic_resolver_query.hpp</code>
- </p>
- <p>
- <span class="bold"><strong>Convenience header: </strong></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 - 2010 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_iterator/operator_eq__eq_.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__basic_resolver_query/address_configured.html"><img src="../../next.png" alt="Next"></a>
- </div>
- </body>
- </html>