• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>ip::basic_resolver::async_resolve (3 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="overload2.html" title="ip::basic_resolver::async_resolve (2 of 6 overloads)">
10<link rel="next" href="overload4.html" title="ip::basic_resolver::async_resolve (4 of 6 overloads)">
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="overload2.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="overload4.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.overload3"></a><a class="link" href="overload3.html" title="ip::basic_resolver::async_resolve (3 of 6 overloads)">ip::basic_resolver::async_resolve
28          (3 of 6 overloads)</a>
29</h5></div></div></div>
30<p>
31            Asynchronously perform forward resolution of a query to a list of entries.
32          </p>
33<pre class="programlisting">template&lt;
34    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;
35<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(
36    string_view host,
37    string_view service,
38    resolver_base::flags resolve_flags,
39    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>);
40</pre>
41<p>
42            This function is used to resolve host and service names into a list of
43            endpoint entries.
44          </p>
45<h6>
46<a name="boost_asio.reference.ip__basic_resolver.async_resolve.overload3.h0"></a>
47            <span class="phrase"><a name="boost_asio.reference.ip__basic_resolver.async_resolve.overload3.parameters"></a></span><a class="link" href="overload3.html#boost_asio.reference.ip__basic_resolver.async_resolve.overload3.parameters">Parameters</a>
48          </h6>
49<div class="variablelist">
50<p class="title"><b></b></p>
51<dl class="variablelist">
52<dt><span class="term">host</span></dt>
53<dd><p>
54                  A string identifying a location. May be a descriptive name or a
55                  numeric address string. If an empty string and the passive flag
56                  has been specified, the resolved endpoints are suitable for local
57                  service binding. If an empty string and passive is not specified,
58                  the resolved endpoints will use the loopback address.
59                </p></dd>
60<dt><span class="term">service</span></dt>
61<dd><p>
62                  A string identifying the requested service. This may be a descriptive
63                  name or a numeric string corresponding to a port number. May be
64                  an empty string, in which case all resolved endpoints will have
65                  a port number of 0.
66                </p></dd>
67<dt><span class="term">resolve_flags</span></dt>
68<dd><p>
69                  A set of flags that determine how name resolution should be performed.
70                  The default flags are suitable for communication with remote hosts.
71                  See the <a class="link" href="../../ip__resolver_base.html" title="ip::resolver_base"><code class="computeroutput">ip::resolver_base</code></a>
72                  documentation for the set of available flags.
73                </p></dd>
74<dt><span class="term">handler</span></dt>
75<dd>
76<p>
77                  The handler to be called when the resolve operation completes.
78                  Copies will be made of the handler as required. The function signature
79                  of the handler must be:
80</p>
81<pre class="programlisting">void handler(
82  const boost::system::error_code&amp; error, // Result of operation.
83  resolver::results_type results // Resolved endpoints as a range.
84);
85</pre>
86<p>
87                  Regardless of whether the asynchronous operation completes immediately
88                  or not, the handler will not be invoked from within this function.
89                  On immediate completion, invocation of the handler will be performed
90                  in a manner equivalent to using <a class="link" href="../../post.html" title="post"><code class="computeroutput">post</code></a>.
91                </p>
92</dd>
93</dl>
94</div>
95<p>
96            A successful resolve operation is guaranteed to pass a non-empty range
97            to the handler.
98          </p>
99<h6>
100<a name="boost_asio.reference.ip__basic_resolver.async_resolve.overload3.h1"></a>
101            <span class="phrase"><a name="boost_asio.reference.ip__basic_resolver.async_resolve.overload3.remarks"></a></span><a class="link" href="overload3.html#boost_asio.reference.ip__basic_resolver.async_resolve.overload3.remarks">Remarks</a>
102          </h6>
103<p>
104            On POSIX systems, host names may be locally defined in the file <code class="computeroutput">/etc/hosts</code>.
105            On Windows, host names may be defined in the file <code class="computeroutput">c:\windows\system32\drivers\etc\hosts</code>.
106            Remote host name resolution is performed using DNS. Operating systems
107            may use additional locations when resolving host names (such as NETBIOS
108            names on Windows).
109          </p>
110<p>
111            On POSIX systems, service names are typically defined in the file <code class="computeroutput">/etc/services</code>.
112            On Windows, service names may be found in the file <code class="computeroutput">c:\windows\system32\drivers\etc\services</code>.
113            Operating systems may use additional locations when resolving service
114            names.
115          </p>
116</div>
117<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
118<td align="left"></td>
119<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M.
120      Kohlhoff<p>
121        Distributed under the Boost Software License, Version 1.0. (See accompanying
122        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>)
123      </p>
124</div></td>
125</tr></table>
126<hr>
127<div class="spirit-nav">
128<a accesskey="p" href="overload2.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="overload4.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
129</div>
130</body>
131</html>
132