doc/html/boost_asio/reference/ip__basic_resolver/async_resolve/overload6.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>ip::basic_resolver::async_resolve (6 of 6 overloads)</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="../async_resolve.html" title="ip::basic_resolver::async_resolve">
   9 <link rel="prev" href="overload5.html" title="ip::basic_resolver::async_resolve (5 of 6 overloads)">
  10 <link rel="next" href="../basic_resolver.html" title="ip::basic_resolver::basic_resolver">
  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="overload5.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../async_resolve.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="../basic_resolver.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h5 class="title">
  27 <a name="boost_asio.reference.ip__basic_resolver.async_resolve.overload6"></a><a class="link" href="overload6.html" title="ip::basic_resolver::async_resolve (6 of 6 overloads)">ip::basic_resolver::async_resolve
  28           (6 of 6 overloads)</a>
  29 </h5></div></div></div>
  30 <p>
  31             Asynchronously perform reverse resolution of an endpoint to a list of
  32             entries.
  33           </p>
  34 <pre class="programlisting">template&lt;
  35     typename <a class="link" href="../../ResolveHandler.html" title="Resolve handler requirements">ResolveHandler</a> = <a class="link" href="../../asynchronous_operations.html#boost_asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>&gt;
  36 <a class="link" href="../../asynchronous_operations.html#boost_asio.reference.asynchronous_operations.automatic_deduction_of_initiating_function_return_type"><span class="emphasis"><em>DEDUCED</em></span></a> async_resolve(
  37     const endpoint_type &amp; e,
  38     ResolveHandler &amp;&amp; handler = <a class="link" href="../../asynchronous_operations.html#boost_asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>);
  39 </pre>
  40 <p>
  41             This function is used to asynchronously resolve an endpoint into a list
  42             of endpoint entries.
  43           </p>
  44 <h6>
  45 <a name="boost_asio.reference.ip__basic_resolver.async_resolve.overload6.h0"></a>
  46             <span class="phrase"><a name="boost_asio.reference.ip__basic_resolver.async_resolve.overload6.parameters"></a></span><a class="link" href="overload6.html#boost_asio.reference.ip__basic_resolver.async_resolve.overload6.parameters">Parameters</a>
  47           </h6>
  48 <div class="variablelist">
  49 <p class="title"><b></b></p>
  50 <dl class="variablelist">
  51 <dt><span class="term">e</span></dt>
  52 <dd><p>
  53                   An endpoint object that determines what endpoints will be returned.
  54                 </p></dd>
  55 <dt><span class="term">handler</span></dt>
  56 <dd>
  57 <p>
  58                   The handler to be called when the resolve operation completes.
  59                   Copies will be made of the handler as required. The function signature
  60                   of the handler must be:
  61 </p>
  62 <pre class="programlisting">void handler(
  63   const boost::system::error_code&amp; error, // Result of operation.
  64   resolver::results_type results // Resolved endpoints as a range.
  65 );
  66 </pre>
  67 <p>
  68                   Regardless of whether the asynchronous operation completes immediately
  69                   or not, the handler will not be invoked from within this function.
  70                   On immediate completion, invocation of the handler will be performed
  71                   in a manner equivalent to using <a class="link" href="../../post.html" title="post"><code class="computeroutput">post</code></a>.
  72                 </p>
  73 </dd>
  74 </dl>
  75 </div>
  76 <p>
  77             A successful resolve operation is guaranteed to pass a non-empty range
  78             to the handler.
  79           </p>
  80 </div>
  81 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  82 <td align="left"></td>
  83 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2019 Christopher M. Kohlhoff<p>
  84         Distributed under the Boost Software License, Version 1.0. (See accompanying
  85         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>)
  86       </p>
  87 </div></td>
  88 </tr></table>
  89 <hr>
  90 <div class="spirit-nav">
  91 <a accesskey="p" href="overload5.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../async_resolve.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="../basic_resolver.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  92 </div>
  93 </body>
  94 </html>