doc/html/boost_asio/reference/ip__basic_resolver.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>ip::basic_resolver</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_endpoint/size.html" title="ip::basic_endpoint::size">
  10 <link rel="next" href="ip__basic_resolver/address_configured.html" title="ip::basic_resolver::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_endpoint/size.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/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"></a><a class="link" href="ip__basic_resolver.html" title="ip::basic_resolver">ip::basic_resolver</a>
  28 </h3></div></div></div>
  29 <p>
  30         Provides endpoint resolution functionality.
  31       </p>
  32 <pre class="programlisting">template&lt;
  33     typename <a class="link" href="InternetProtocol.html" title="Internet protocol requirements">InternetProtocol</a>,
  34     typename <a class="link" href="Executor1.html" title="Executor requirements">Executor</a>&gt;
  35 class basic_resolver :
  36   public ip::resolver_base
  37 </pre>
  38 <h5>
  39 <a name="boost_asio.reference.ip__basic_resolver.h0"></a>
  40         <span class="phrase"><a name="boost_asio.reference.ip__basic_resolver.types"></a></span><a class="link" href="ip__basic_resolver.html#boost_asio.reference.ip__basic_resolver.types">Types</a>
  41       </h5>
  42 <div class="informaltable"><table class="table">
  43 <colgroup>
  44 <col>
  45 <col>
  46 </colgroup>
  47 <thead><tr>
  48 <th>
  49                 <p>
  50                   Name
  51                 </p>
  52               </th>
  53 <th>
  54                 <p>
  55                   Description
  56                 </p>
  57               </th>
  58 </tr></thead>
  59 <tbody>
  60 <tr>
  61 <td>
  62                 <p>
  63                   <a class="link" href="ip__basic_resolver__rebind_executor.html" title="ip::basic_resolver::rebind_executor"><span class="bold"><strong>rebind_executor</strong></span></a>
  64                 </p>
  65               </td>
  66 <td>
  67                 <p>
  68                   Rebinds the resolver type to another executor.
  69                 </p>
  70               </td>
  71 </tr>
  72 <tr>
  73 <td>
  74                 <p>
  75                   <a class="link" href="ip__basic_resolver/endpoint_type.html" title="ip::basic_resolver::endpoint_type"><span class="bold"><strong>endpoint_type</strong></span></a>
  76                 </p>
  77               </td>
  78 <td>
  79                 <p>
  80                   The endpoint type.
  81                 </p>
  82               </td>
  83 </tr>
  84 <tr>
  85 <td>
  86                 <p>
  87                   <a class="link" href="ip__basic_resolver/executor_type.html" title="ip::basic_resolver::executor_type"><span class="bold"><strong>executor_type</strong></span></a>
  88                 </p>
  89               </td>
  90 <td>
  91                 <p>
  92                   The type of the executor associated with the object.
  93                 </p>
  94               </td>
  95 </tr>
  96 <tr>
  97 <td>
  98                 <p>
  99                   <a class="link" href="ip__basic_resolver/flags.html" title="ip::basic_resolver::flags"><span class="bold"><strong>flags</strong></span></a>
 100                 </p>
 101               </td>
 102 <td>
 103                 <p>
 104                   A bitmask type (C++ Std [lib.bitmask.types]).
 105                 </p>
 106               </td>
 107 </tr>
 108 <tr>
 109 <td>
 110                 <p>
 111                   <a class="link" href="ip__basic_resolver/iterator.html" title="ip::basic_resolver::iterator"><span class="bold"><strong>iterator</strong></span></a>
 112                 </p>
 113               </td>
 114 <td>
 115                 <p>
 116                   (Deprecated.) The iterator type.
 117                 </p>
 118               </td>
 119 </tr>
 120 <tr>
 121 <td>
 122                 <p>
 123                   <a class="link" href="ip__basic_resolver/protocol_type.html" title="ip::basic_resolver::protocol_type"><span class="bold"><strong>protocol_type</strong></span></a>
 124                 </p>
 125               </td>
 126 <td>
 127                 <p>
 128                   The protocol type.
 129                 </p>
 130               </td>
 131 </tr>
 132 <tr>
 133 <td>
 134                 <p>
 135                   <a class="link" href="ip__basic_resolver/query.html" title="ip::basic_resolver::query"><span class="bold"><strong>query</strong></span></a>
 136                 </p>
 137               </td>
 138 <td>
 139                 <p>
 140                   (Deprecated.) The query type.
 141                 </p>
 142               </td>
 143 </tr>
 144 <tr>
 145 <td>
 146                 <p>
 147                   <a class="link" href="ip__basic_resolver/results_type.html" title="ip::basic_resolver::results_type"><span class="bold"><strong>results_type</strong></span></a>
 148                 </p>
 149               </td>
 150 <td>
 151                 <p>
 152                   The results type.
 153                 </p>
 154               </td>
 155 </tr>
 156 </tbody>
 157 </table></div>
 158 <h5>
 159 <a name="boost_asio.reference.ip__basic_resolver.h1"></a>
 160         <span class="phrase"><a name="boost_asio.reference.ip__basic_resolver.member_functions"></a></span><a class="link" href="ip__basic_resolver.html#boost_asio.reference.ip__basic_resolver.member_functions">Member
 161         Functions</a>
 162       </h5>
 163 <div class="informaltable"><table class="table">
 164 <colgroup>
 165 <col>
 166 <col>
 167 </colgroup>
 168 <thead><tr>
 169 <th>
 170                 <p>
 171                   Name
 172                 </p>
 173               </th>
 174 <th>
 175                 <p>
 176                   Description
 177                 </p>
 178               </th>
 179 </tr></thead>
 180 <tbody>
 181 <tr>
 182 <td>
 183                 <p>
 184                   <a class="link" href="ip__basic_resolver/async_resolve.html" title="ip::basic_resolver::async_resolve"><span class="bold"><strong>async_resolve</strong></span></a>
 185                 </p>
 186               </td>
 187 <td>
 188                 <p>
 189                   (Deprecated: Use overload with separate host and service parameters.)
 190                   Asynchronously perform forward resolution of a query to a list
 191                   of entries. <br> <span class="silver"> &#8212;</span><br> Asynchronously perform forward resolution
 192                   of a query to a list of entries. <br> <span class="silver"> &#8212;</span><br> Asynchronously perform
 193                   reverse resolution of an endpoint to a list of entries.
 194                 </p>
 195               </td>
 196 </tr>
 197 <tr>
 198 <td>
 199                 <p>
 200                   <a class="link" href="ip__basic_resolver/basic_resolver.html" title="ip::basic_resolver::basic_resolver"><span class="bold"><strong>basic_resolver</strong></span></a>
 201                 </p>
 202               </td>
 203 <td>
 204                 <p>
 205                   Construct with executor. <br> <span class="silver"> &#8212;</span><br> Construct with execution
 206                   context. <br> <span class="silver"> &#8212;</span><br> Move-construct a basic_resolver from another.
 207                 </p>
 208               </td>
 209 </tr>
 210 <tr>
 211 <td>
 212                 <p>
 213                   <a class="link" href="ip__basic_resolver/cancel.html" title="ip::basic_resolver::cancel"><span class="bold"><strong>cancel</strong></span></a>
 214                 </p>
 215               </td>
 216 <td>
 217                 <p>
 218                   Cancel any asynchronous operations that are waiting on the resolver.
 219                 </p>
 220               </td>
 221 </tr>
 222 <tr>
 223 <td>
 224                 <p>
 225                   <a class="link" href="ip__basic_resolver/get_executor.html" title="ip::basic_resolver::get_executor"><span class="bold"><strong>get_executor</strong></span></a>
 226                 </p>
 227               </td>
 228 <td>
 229                 <p>
 230                   Get the executor associated with the object.
 231                 </p>
 232               </td>
 233 </tr>
 234 <tr>
 235 <td>
 236                 <p>
 237                   <a class="link" href="ip__basic_resolver/operator_eq_.html" title="ip::basic_resolver::operator="><span class="bold"><strong>operator=</strong></span></a>
 238                 </p>
 239               </td>
 240 <td>
 241                 <p>
 242                   Move-assign a basic_resolver from another.
 243                 </p>
 244               </td>
 245 </tr>
 246 <tr>
 247 <td>
 248                 <p>
 249                   <a class="link" href="ip__basic_resolver/resolve.html" title="ip::basic_resolver::resolve"><span class="bold"><strong>resolve</strong></span></a>
 250                 </p>
 251               </td>
 252 <td>
 253                 <p>
 254                   (Deprecated: Use overload with separate host and service parameters.)
 255                   Perform forward resolution of a query to a list of entries. <br>
 256                   <span class="silver"> &#8212;</span><br> Perform forward resolution of a query to a list of entries.
 257                   <br> <span class="silver"> &#8212;</span><br> Perform reverse resolution of an endpoint to a list
 258                   of entries.
 259                 </p>
 260               </td>
 261 </tr>
 262 <tr>
 263 <td>
 264                 <p>
 265                   <a class="link" href="ip__basic_resolver/_basic_resolver.html" title="ip::basic_resolver::~basic_resolver"><span class="bold"><strong>~basic_resolver</strong></span></a>
 266                 </p>
 267               </td>
 268 <td>
 269                 <p>
 270                   Destroys the resolver.
 271                 </p>
 272               </td>
 273 </tr>
 274 </tbody>
 275 </table></div>
 276 <h5>
 277 <a name="boost_asio.reference.ip__basic_resolver.h2"></a>
 278         <span class="phrase"><a name="boost_asio.reference.ip__basic_resolver.data_members"></a></span><a class="link" href="ip__basic_resolver.html#boost_asio.reference.ip__basic_resolver.data_members">Data Members</a>
 279       </h5>
 280 <div class="informaltable"><table class="table">
 281 <colgroup>
 282 <col>
 283 <col>
 284 </colgroup>
 285 <thead><tr>
 286 <th>
 287                 <p>
 288                   Name
 289                 </p>
 290               </th>
 291 <th>
 292                 <p>
 293                   Description
 294                 </p>
 295               </th>
 296 </tr></thead>
 297 <tbody>
 298 <tr>
 299 <td>
 300                 <p>
 301                   <a class="link" href="ip__basic_resolver/address_configured.html" title="ip::basic_resolver::address_configured"><span class="bold"><strong>address_configured</strong></span></a>
 302                 </p>
 303               </td>
 304 <td>
 305                 <p>
 306                   Only return IPv4 addresses if a non-loopback IPv4 address is configured
 307                   for the system. Only return IPv6 addresses if a non-loopback IPv6
 308                   address is configured for the system.
 309                 </p>
 310               </td>
 311 </tr>
 312 <tr>
 313 <td>
 314                 <p>
 315                   <a class="link" href="ip__basic_resolver/all_matching.html" title="ip::basic_resolver::all_matching"><span class="bold"><strong>all_matching</strong></span></a>
 316                 </p>
 317               </td>
 318 <td>
 319                 <p>
 320                   If used with v4_mapped, return all matching IPv6 and IPv4 addresses.
 321                 </p>
 322               </td>
 323 </tr>
 324 <tr>
 325 <td>
 326                 <p>
 327                   <a class="link" href="ip__basic_resolver/canonical_name.html" title="ip::basic_resolver::canonical_name"><span class="bold"><strong>canonical_name</strong></span></a>
 328                 </p>
 329               </td>
 330 <td>
 331                 <p>
 332                   Determine the canonical name of the host specified in the query.
 333                 </p>
 334               </td>
 335 </tr>
 336 <tr>
 337 <td>
 338                 <p>
 339                   <a class="link" href="ip__basic_resolver/numeric_host.html" title="ip::basic_resolver::numeric_host"><span class="bold"><strong>numeric_host</strong></span></a>
 340                 </p>
 341               </td>
 342 <td>
 343                 <p>
 344                   Host name should be treated as a numeric string defining an IPv4
 345                   or IPv6 address and no name resolution should be attempted.
 346                 </p>
 347               </td>
 348 </tr>
 349 <tr>
 350 <td>
 351                 <p>
 352                   <a class="link" href="ip__basic_resolver/numeric_service.html" title="ip::basic_resolver::numeric_service"><span class="bold"><strong>numeric_service</strong></span></a>
 353                 </p>
 354               </td>
 355 <td>
 356                 <p>
 357                   Service name should be treated as a numeric string defining a port
 358                   number and no name resolution should be attempted.
 359                 </p>
 360               </td>
 361 </tr>
 362 <tr>
 363 <td>
 364                 <p>
 365                   <a class="link" href="ip__basic_resolver/passive.html" title="ip::basic_resolver::passive"><span class="bold"><strong>passive</strong></span></a>
 366                 </p>
 367               </td>
 368 <td>
 369                 <p>
 370                   Indicate that returned endpoint is intended for use as a locally
 371                   bound socket endpoint.
 372                 </p>
 373               </td>
 374 </tr>
 375 <tr>
 376 <td>
 377                 <p>
 378                   <a class="link" href="ip__basic_resolver/v4_mapped.html" title="ip::basic_resolver::v4_mapped"><span class="bold"><strong>v4_mapped</strong></span></a>
 379                 </p>
 380               </td>
 381 <td>
 382                 <p>
 383                   If the query protocol family is specified as IPv6, return IPv4-mapped
 384                   IPv6 addresses on finding no IPv6 addresses.
 385                 </p>
 386               </td>
 387 </tr>
 388 </tbody>
 389 </table></div>
 390 <p>
 391         The <a class="link" href="ip__basic_resolver.html" title="ip::basic_resolver"><code class="computeroutput">ip::basic_resolver</code></a>
 392         class template provides the ability to resolve a query to a list of endpoints.
 393       </p>
 394 <h5>
 395 <a name="boost_asio.reference.ip__basic_resolver.h3"></a>
 396         <span class="phrase"><a name="boost_asio.reference.ip__basic_resolver.thread_safety"></a></span><a class="link" href="ip__basic_resolver.html#boost_asio.reference.ip__basic_resolver.thread_safety">Thread Safety</a>
 397       </h5>
 398 <p>
 399         <span class="emphasis"><em>Distinct</em></span> <span class="emphasis"><em>objects:</em></span> Safe.
 400       </p>
 401 <p>
 402         <span class="emphasis"><em>Shared</em></span> <span class="emphasis"><em>objects:</em></span> Unsafe.
 403       </p>
 404 <h5>
 405 <a name="boost_asio.reference.ip__basic_resolver.h4"></a>
 406         <span class="phrase"><a name="boost_asio.reference.ip__basic_resolver.requirements"></a></span><a class="link" href="ip__basic_resolver.html#boost_asio.reference.ip__basic_resolver.requirements">Requirements</a>
 407       </h5>
 408 <p>
 409         <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/ip/basic_resolver.hpp</code>
 410       </p>
 411 <p>
 412         <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code>
 413       </p>
 414 </div>
 415 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 416 <td align="left"></td>
 417 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2019 Christopher M. Kohlhoff<p>
 418         Distributed under the Boost Software License, Version 1.0. (See accompanying
 419         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>)
 420       </p>
 421 </div></td>
 422 </tr></table>
 423 <hr>
 424 <div class="spirit-nav">
 425 <a accesskey="p" href="ip__basic_endpoint/size.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/address_configured.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 426 </div>
 427 </body>
 428 </html>