ip__basic_resolver.html
15.6 KB
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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ip::basic_resolver</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../index.html" title="Asio">
<link rel="up" href="../reference.html" title="Reference">
<link rel="prev" href="ip__basic_endpoint/size.html" title="ip::basic_endpoint::size">
<link rel="next" href="ip__basic_resolver/address_configured.html" title="ip::basic_resolver::address_configured">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="ip__basic_endpoint/size.html"><img src="../../prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../home.png" alt="Home"></a><a accesskey="n" href="ip__basic_resolver/address_configured.html"><img src="../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="asio.reference.ip__basic_resolver"></a><a class="link" href="ip__basic_resolver.html" title="ip::basic_resolver">ip::basic_resolver</a>
</h3></div></div></div>
<p>
Provides endpoint resolution functionality.
</p>
<pre class="programlisting">template<
typename <a class="link" href="InternetProtocol.html" title="Internet protocol requirements">InternetProtocol</a>,
typename <a class="link" href="Executor1.html" title="Executor requirements">Executor</a>>
class basic_resolver :
public ip::resolver_base
</pre>
<h5>
<a name="asio.reference.ip__basic_resolver.h0"></a>
<span><a name="asio.reference.ip__basic_resolver.types"></a></span><a class="link" href="ip__basic_resolver.html#asio.reference.ip__basic_resolver.types">Types</a>
</h5>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
<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>
</p>
</td>
<td>
<p>
Rebinds the resolver type to another executor.
</p>
</td>
</tr>
<tr>
<td>
<p>
<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>
</p>
</td>
<td>
<p>
The endpoint type.
</p>
</td>
</tr>
<tr>
<td>
<p>
<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>
</p>
</td>
<td>
<p>
The type of the executor associated with the object.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ip__basic_resolver/flags.html" title="ip::basic_resolver::flags"><span class="bold"><strong>flags</strong></span></a>
</p>
</td>
<td>
<p>
A bitmask type (C++ Std [lib.bitmask.types]).
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ip__basic_resolver/iterator.html" title="ip::basic_resolver::iterator"><span class="bold"><strong>iterator</strong></span></a>
</p>
</td>
<td>
<p>
(Deprecated.) The iterator type.
</p>
</td>
</tr>
<tr>
<td>
<p>
<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>
</p>
</td>
<td>
<p>
The protocol type.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ip__basic_resolver/query.html" title="ip::basic_resolver::query"><span class="bold"><strong>query</strong></span></a>
</p>
</td>
<td>
<p>
(Deprecated.) The query type.
</p>
</td>
</tr>
<tr>
<td>
<p>
<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>
</p>
</td>
<td>
<p>
The results type.
</p>
</td>
</tr>
</tbody>
</table></div>
<h5>
<a name="asio.reference.ip__basic_resolver.h1"></a>
<span><a name="asio.reference.ip__basic_resolver.member_functions"></a></span><a class="link" href="ip__basic_resolver.html#asio.reference.ip__basic_resolver.member_functions">Member
Functions</a>
</h5>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
<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>
</p>
</td>
<td>
<p>
(Deprecated: Use overload with separate host and service parameters.)
Asynchronously perform forward resolution of a query to a list
of entries. <br> <span class="silver"> —</span><br> Asynchronously perform forward resolution
of a query to a list of entries. <br> <span class="silver"> —</span><br> Asynchronously perform
reverse resolution of an endpoint to a list of entries.
</p>
</td>
</tr>
<tr>
<td>
<p>
<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> <span class="silver">[constructor]</span>
</p>
</td>
<td>
<p>
Construct with executor. <br> <span class="silver"> —</span><br> Construct with execution
context. <br> <span class="silver"> —</span><br> Move-construct a basic_resolver from another.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ip__basic_resolver/cancel.html" title="ip::basic_resolver::cancel"><span class="bold"><strong>cancel</strong></span></a>
</p>
</td>
<td>
<p>
Cancel any asynchronous operations that are waiting on the resolver.
</p>
</td>
</tr>
<tr>
<td>
<p>
<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>
</p>
</td>
<td>
<p>
Get the executor associated with the object.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ip__basic_resolver/operator_eq_.html" title="ip::basic_resolver::operator="><span class="bold"><strong>operator=</strong></span></a>
</p>
</td>
<td>
<p>
Move-assign a basic_resolver from another.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ip__basic_resolver/resolve.html" title="ip::basic_resolver::resolve"><span class="bold"><strong>resolve</strong></span></a>
</p>
</td>
<td>
<p>
(Deprecated: Use overload with separate host and service parameters.)
Perform forward resolution of a query to a list of entries. <br>
<span class="silver"> —</span><br> Perform forward resolution of a query to a list of entries.
<br> <span class="silver"> —</span><br> Perform reverse resolution of an endpoint to a list
of entries.
</p>
</td>
</tr>
<tr>
<td>
<p>
<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> <span class="silver">[destructor]</span>
</p>
</td>
<td>
<p>
Destroys the resolver.
</p>
</td>
</tr>
</tbody>
</table></div>
<h5>
<a name="asio.reference.ip__basic_resolver.h2"></a>
<span><a name="asio.reference.ip__basic_resolver.data_members"></a></span><a class="link" href="ip__basic_resolver.html#asio.reference.ip__basic_resolver.data_members">Data
Members</a>
</h5>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
<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> <span class="silver">[static]</span>
</p>
</td>
<td>
<p>
Only return IPv4 addresses if a non-loopback IPv4 address is configured
for the system. Only return IPv6 addresses if a non-loopback IPv6
address is configured for the system.
</p>
</td>
</tr>
<tr>
<td>
<p>
<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> <span class="silver">[static]</span>
</p>
</td>
<td>
<p>
If used with v4_mapped, return all matching IPv6 and IPv4 addresses.
</p>
</td>
</tr>
<tr>
<td>
<p>
<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> <span class="silver">[static]</span>
</p>
</td>
<td>
<p>
Determine the canonical name of the host specified in the query.
</p>
</td>
</tr>
<tr>
<td>
<p>
<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> <span class="silver">[static]</span>
</p>
</td>
<td>
<p>
Host name should be treated as a numeric string defining an IPv4
or IPv6 address and no name resolution should be attempted.
</p>
</td>
</tr>
<tr>
<td>
<p>
<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> <span class="silver">[static]</span>
</p>
</td>
<td>
<p>
Service name should be treated as a numeric string defining a port
number and no name resolution should be attempted.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ip__basic_resolver/passive.html" title="ip::basic_resolver::passive"><span class="bold"><strong>passive</strong></span></a> <span class="silver">[static]</span>
</p>
</td>
<td>
<p>
Indicate that returned endpoint is intended for use as a locally
bound socket endpoint.
</p>
</td>
</tr>
<tr>
<td>
<p>
<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> <span class="silver">[static]</span>
</p>
</td>
<td>
<p>
If the query protocol family is specified as IPv6, return IPv4-mapped
IPv6 addresses on finding no IPv6 addresses.
</p>
</td>
</tr>
</tbody>
</table></div>
<p>
The <a class="link" href="ip__basic_resolver.html" title="ip::basic_resolver"><code class="computeroutput">ip::basic_resolver</code></a>
class template provides the ability to resolve a query to a list of endpoints.
</p>
<h5>
<a name="asio.reference.ip__basic_resolver.h3"></a>
<span><a name="asio.reference.ip__basic_resolver.thread_safety"></a></span><a class="link" href="ip__basic_resolver.html#asio.reference.ip__basic_resolver.thread_safety">Thread
Safety</a>
</h5>
<p>
<span class="emphasis"><em>Distinct</em></span> <span class="emphasis"><em>objects:</em></span> Safe.
</p>
<p>
<span class="emphasis"><em>Shared</em></span> <span class="emphasis"><em>objects:</em></span> Unsafe.
</p>
<h5>
<a name="asio.reference.ip__basic_resolver.h4"></a>
<span><a name="asio.reference.ip__basic_resolver.requirements"></a></span><a class="link" href="ip__basic_resolver.html#asio.reference.ip__basic_resolver.requirements">Requirements</a>
</h5>
<p>
<span class="emphasis"><em>Header: </em></span><code class="literal">asio/ip/basic_resolver.hpp</code>
</p>
<p>
<span class="emphasis"><em>Convenience header: </em></span><code class="literal">asio.hpp</code>
</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 © 2003-2020 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="ip__basic_endpoint/size.html"><img src="../../prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../home.png" alt="Home"></a><a accesskey="n" href="ip__basic_resolver/address_configured.html"><img src="../../next.png" alt="Next"></a>
</div>
</body>
</html>