doc/html/boost_asio/reference/ip__basic_resolver_query.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>ip::basic_resolver_query</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__basic_resolver_iterator/value_type.html" title="ip::basic_resolver_iterator::value_type">
  10 <link rel="next" href="ip__basic_resolver_query/address_configured.html" title="ip::basic_resolver_query::address_configured">
  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__basic_resolver_iterator/value_type.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_query/address_configured.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__basic_resolver_query"></a><a class="link" href="ip__basic_resolver_query.html" title="ip::basic_resolver_query">ip::basic_resolver_query</a>
  28 </h3></div></div></div>
  29 <p>
  30         An query to be passed to a resolver.
  31       </p>
  32 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
  33     <span class="keyword">typename</span> <a class="link" href="InternetProtocol.html" title="Internet protocol requirements">InternetProtocol</a><span class="special">&gt;</span>
  34 <span class="keyword">class</span> <span class="identifier">basic_resolver_query</span> <span class="special">:</span>
  35   <span class="keyword">public</span> <span class="identifier">ip</span><span class="special">::</span><span class="identifier">resolver_query_base</span>
  36 </pre>
  37 <h5>
  38 <a name="boost_asio.reference.ip__basic_resolver_query.h0"></a>
  39         <span class="phrase"><a name="boost_asio.reference.ip__basic_resolver_query.types"></a></span><a class="link" href="ip__basic_resolver_query.html#boost_asio.reference.ip__basic_resolver_query.types">Types</a>
  40       </h5>
  41 <div class="informaltable"><table class="table">
  42 <colgroup>
  43 <col>
  44 <col>
  45 </colgroup>
  46 <thead><tr>
  47 <th>
  48                 <p>
  49                   Name
  50                 </p>
  51               </th>
  52 <th>
  53                 <p>
  54                   Description
  55                 </p>
  56               </th>
  57 </tr></thead>
  58 <tbody>
  59 <tr>
  60 <td>
  61                 <p>
  62                   <a class="link" href="ip__basic_resolver_query/flags.html" title="ip::basic_resolver_query::flags"><span class="bold"><strong>flags</strong></span></a>
  63                 </p>
  64               </td>
  65 <td>
  66                 <p>
  67                   A bitmask type (C++ Std [lib.bitmask.types]).
  68                 </p>
  69               </td>
  70 </tr>
  71 <tr>
  72 <td>
  73                 <p>
  74                   <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>
  75                 </p>
  76               </td>
  77 <td>
  78                 <p>
  79                   The protocol type associated with the endpoint query.
  80                 </p>
  81               </td>
  82 </tr>
  83 </tbody>
  84 </table></div>
  85 <h5>
  86 <a name="boost_asio.reference.ip__basic_resolver_query.h1"></a>
  87         <span class="phrase"><a name="boost_asio.reference.ip__basic_resolver_query.member_functions"></a></span><a class="link" href="ip__basic_resolver_query.html#boost_asio.reference.ip__basic_resolver_query.member_functions">Member
  88         Functions</a>
  89       </h5>
  90 <div class="informaltable"><table class="table">
  91 <colgroup>
  92 <col>
  93 <col>
  94 </colgroup>
  95 <thead><tr>
  96 <th>
  97                 <p>
  98                   Name
  99                 </p>
 100               </th>
 101 <th>
 102                 <p>
 103                   Description
 104                 </p>
 105               </th>
 106 </tr></thead>
 107 <tbody>
 108 <tr>
 109 <td>
 110                 <p>
 111                   <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>
 112                 </p>
 113               </td>
 114 <td>
 115                 <p>
 116                   Construct with specified service name for any protocol.
 117                 </p>
 118                 <p>
 119                   Construct with specified service name for a given protocol.
 120                 </p>
 121                 <p>
 122                   Construct with specified host name and service name for any protocol.
 123                 </p>
 124                 <p>
 125                   Construct with specified host name and service name for a given
 126                   protocol.
 127                 </p>
 128               </td>
 129 </tr>
 130 <tr>
 131 <td>
 132                 <p>
 133                   <a class="link" href="ip__basic_resolver_query/hints.html" title="ip::basic_resolver_query::hints"><span class="bold"><strong>hints</strong></span></a>
 134                 </p>
 135               </td>
 136 <td>
 137                 <p>
 138                   Get the hints associated with the query.
 139                 </p>
 140               </td>
 141 </tr>
 142 <tr>
 143 <td>
 144                 <p>
 145                   <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>
 146                 </p>
 147               </td>
 148 <td>
 149                 <p>
 150                   Get the host name associated with the query.
 151                 </p>
 152               </td>
 153 </tr>
 154 <tr>
 155 <td>
 156                 <p>
 157                   <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>
 158                 </p>
 159               </td>
 160 <td>
 161                 <p>
 162                   Get the service name associated with the query.
 163                 </p>
 164               </td>
 165 </tr>
 166 </tbody>
 167 </table></div>
 168 <h5>
 169 <a name="boost_asio.reference.ip__basic_resolver_query.h2"></a>
 170         <span class="phrase"><a name="boost_asio.reference.ip__basic_resolver_query.data_members"></a></span><a class="link" href="ip__basic_resolver_query.html#boost_asio.reference.ip__basic_resolver_query.data_members">Data
 171         Members</a>
 172       </h5>
 173 <div class="informaltable"><table class="table">
 174 <colgroup>
 175 <col>
 176 <col>
 177 </colgroup>
 178 <thead><tr>
 179 <th>
 180                 <p>
 181                   Name
 182                 </p>
 183               </th>
 184 <th>
 185                 <p>
 186                   Description
 187                 </p>
 188               </th>
 189 </tr></thead>
 190 <tbody>
 191 <tr>
 192 <td>
 193                 <p>
 194                   <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>
 195                 </p>
 196               </td>
 197 <td>
 198                 <p>
 199                   Only return IPv4 addresses if a non-loopback IPv4 address is configured
 200                   for the system. Only return IPv6 addresses if a non-loopback IPv6
 201                   address is configured for the system.
 202                 </p>
 203               </td>
 204 </tr>
 205 <tr>
 206 <td>
 207                 <p>
 208                   <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>
 209                 </p>
 210               </td>
 211 <td>
 212                 <p>
 213                   If used with v4_mapped, return all matching IPv6 and IPv4 addresses.
 214                 </p>
 215               </td>
 216 </tr>
 217 <tr>
 218 <td>
 219                 <p>
 220                   <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>
 221                 </p>
 222               </td>
 223 <td>
 224                 <p>
 225                   Determine the canonical name of the host specified in the query.
 226                 </p>
 227               </td>
 228 </tr>
 229 <tr>
 230 <td>
 231                 <p>
 232                   <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>
 233                 </p>
 234               </td>
 235 <td>
 236                 <p>
 237                   Host name should be treated as a numeric string defining an IPv4
 238                   or IPv6 address and no name resolution should be attempted.
 239                 </p>
 240               </td>
 241 </tr>
 242 <tr>
 243 <td>
 244                 <p>
 245                   <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>
 246                 </p>
 247               </td>
 248 <td>
 249                 <p>
 250                   Service name should be treated as a numeric string defining a port
 251                   number and no name resolution should be attempted.
 252                 </p>
 253               </td>
 254 </tr>
 255 <tr>
 256 <td>
 257                 <p>
 258                   <a class="link" href="ip__basic_resolver_query/passive.html" title="ip::basic_resolver_query::passive"><span class="bold"><strong>passive</strong></span></a>
 259                 </p>
 260               </td>
 261 <td>
 262                 <p>
 263                   Indicate that returned endpoint is intended for use as a locally
 264                   bound socket endpoint.
 265                 </p>
 266               </td>
 267 </tr>
 268 <tr>
 269 <td>
 270                 <p>
 271                   <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>
 272                 </p>
 273               </td>
 274 <td>
 275                 <p>
 276                   If the query protocol family is specified as IPv6, return IPv4-mapped
 277                   IPv6 addresses on finding no IPv6 addresses.
 278                 </p>
 279               </td>
 280 </tr>
 281 </tbody>
 282 </table></div>
 283 <p>
 284         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>
 285         class template describes a query that can be passed to a resolver.
 286       </p>
 287 <h5>
 288 <a name="boost_asio.reference.ip__basic_resolver_query.h3"></a>
 289         <span class="phrase"><a name="boost_asio.reference.ip__basic_resolver_query.thread_safety"></a></span><a class="link" href="ip__basic_resolver_query.html#boost_asio.reference.ip__basic_resolver_query.thread_safety">Thread
 290         Safety</a>
 291       </h5>
 292 <p>
 293         <span class="emphasis"><em>Distinct</em></span> <span class="emphasis"><em>objects:</em></span> Safe.
 294       </p>
 295 <p>
 296         <span class="emphasis"><em>Shared</em></span> <span class="emphasis"><em>objects:</em></span> Unsafe.
 297       </p>
 298 <h5>
 299 <a name="boost_asio.reference.ip__basic_resolver_query.h4"></a>
 300         <span class="phrase"><a name="boost_asio.reference.ip__basic_resolver_query.requirements"></a></span><a class="link" href="ip__basic_resolver_query.html#boost_asio.reference.ip__basic_resolver_query.requirements">Requirements</a>
 301       </h5>
 302 <p>
 303         <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/ip/basic_resolver_query.hpp</code>
 304       </p>
 305 <p>
 306         <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code>
 307       </p>
 308 </div>
 309 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 310 <td align="left"></td>
 311 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2017 Christopher M. Kohlhoff<p>
 312         Distributed under the Boost Software License, Version 1.0. (See accompanying
 313         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>)
 314       </p>
 315 </div></td>
 316 </tr></table>
 317 <hr>
 318 <div class="spirit-nav">
 319 <a accesskey="p" href="ip__basic_resolver_iterator/value_type.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_query/address_configured.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 320 </div>
 321 </body>
 322 </html>