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