summaryrefslogtreecommitdiff
path: root/doc/html/boost_asio/reference/ip__basic_resolver/async_resolve/overload3.html
blob: 9bfa03cf574e4d49211dae9e3fa4db12e9ec14a8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>ip::basic_resolver::async_resolve (3 of 6 overloads)</title>
<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio">
<link rel="up" href="../async_resolve.html" title="ip::basic_resolver::async_resolve">
<link rel="prev" href="overload2.html" title="ip::basic_resolver::async_resolve (2 of 6 overloads)">
<link rel="next" href="overload4.html" title="ip::basic_resolver::async_resolve (4 of 6 overloads)">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<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>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<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
          (3 of 6 overloads)</a>
</h5></div></div></div>
<p>
            Asynchronously perform forward resolution of a query to a list of entries.
          </p>
<pre class="programlisting">template&lt;
    typename <a class="link" href="../../ResolveHandler.html" title="Resolve handler requirements">ResolveHandler</a>&gt;
<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(
    string_view host,
    string_view service,
    resolver_base::flags resolve_flags,
    ResolveHandler &amp;&amp; handler);
</pre>
<p>
            This function is used to resolve host and service names into a list of
            endpoint entries.
          </p>
<h6>
<a name="boost_asio.reference.ip__basic_resolver.async_resolve.overload3.h0"></a>
            <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>
          </h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl class="variablelist">
<dt><span class="term">host</span></dt>
<dd><p>
                  A string identifying a location. May be a descriptive name or a
                  numeric address string. If an empty string and the passive flag
                  has been specified, the resolved endpoints are suitable for local
                  service binding. If an empty string and passive is not specified,
                  the resolved endpoints will use the loopback address.
                </p></dd>
<dt><span class="term">service</span></dt>
<dd><p>
                  A string identifying the requested service. This may be a descriptive
                  name or a numeric string corresponding to a port number. May be
                  an empty string, in which case all resolved endpoints will have
                  a port number of 0.
                </p></dd>
<dt><span class="term">resolve_flags</span></dt>
<dd><p>
                  A set of flags that determine how name resolution should be performed.
                  The default flags are suitable for communication with remote hosts.
                  See the <a class="link" href="../../ip__resolver_base.html" title="ip::resolver_base"><code class="computeroutput">ip::resolver_base</code></a>
                  documentation for the set of available flags.
                </p></dd>
<dt><span class="term">handler</span></dt>
<dd>
<p>
                  The handler to be called when the resolve operation completes.
                  Copies will be made of the handler as required. The function signature
                  of the handler must be:
</p>
<pre class="programlisting">void handler(
  const boost::system::error_code&amp; error, // Result of operation.
  resolver::results_type results // Resolved endpoints as a range.
);
</pre>
<p>
                  Regardless of whether the asynchronous operation completes immediately
                  or not, the handler will not be invoked from within this function.
                  On immediate completion, invocation of the handler will be performed
                  in a manner equivalent to using <a class="link" href="../../post.html" title="post"><code class="computeroutput">post</code></a>.
                </p>
</dd>
</dl>
</div>
<p>
            A successful resolve operation is guaranteed to pass a non-empty range
            to the handler.
          </p>
<h6>
<a name="boost_asio.reference.ip__basic_resolver.async_resolve.overload3.h1"></a>
            <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>
          </h6>
<p>
            On POSIX systems, host names may be locally defined in the file <code class="computeroutput">/etc/hosts</code>.
            On Windows, host names may be defined in the file <code class="computeroutput">c:\windows\system32\drivers\etc\hosts</code>.
            Remote host name resolution is performed using DNS. Operating systems
            may use additional locations when resolving host names (such as NETBIOS
            names on Windows).
          </p>
<p>
            On POSIX systems, service names are typically defined in the file <code class="computeroutput">/etc/services</code>.
            On Windows, service names may be found in the file <code class="computeroutput">c:\windows\system32\drivers\etc\services</code>.
            Operating systems may use additional locations when resolving service
            names.
          </p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2003-2019 Christopher M. Kohlhoff<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        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>)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<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>
</div>
</body>
</html>