doc/html/boost_asio/reference/ip__icmp/resolver.html

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