• 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::results_type</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__basic_resolver.html" title="ip::basic_resolver">
9<link rel="prev" href="resolve/overload12.html" title="ip::basic_resolver::resolve (12 of 12 overloads)">
10<link rel="next" href="v4_mapped.html" title="ip::basic_resolver::v4_mapped">
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="resolve/overload12.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../ip__basic_resolver.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="v4_mapped.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__basic_resolver.results_type"></a><a class="link" href="results_type.html" title="ip::basic_resolver::results_type">ip::basic_resolver::results_type</a>
28</h4></div></div></div>
29<p>
30          <a class="indexterm" name="boost_asio.indexterm.ip__basic_resolver.results_type"></a>
31The
32          results type.
33        </p>
34<pre class="programlisting">typedef basic_resolver_results&lt; InternetProtocol &gt; results_type;
35</pre>
36<h6>
37<a name="boost_asio.reference.ip__basic_resolver.results_type.h0"></a>
38          <span class="phrase"><a name="boost_asio.reference.ip__basic_resolver.results_type.types"></a></span><a class="link" href="results_type.html#boost_asio.reference.ip__basic_resolver.results_type.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_results/const_iterator.html" title="ip::basic_resolver_results::const_iterator"><span class="bold"><strong>const_iterator</strong></span></a>
62                  </p>
63                </td>
64<td>
65                  <p>
66                    The type of an iterator into the range.
67                  </p>
68                </td>
69</tr>
70<tr>
71<td>
72                  <p>
73                    <a class="link" href="../ip__basic_resolver_results/const_reference.html" title="ip::basic_resolver_results::const_reference"><span class="bold"><strong>const_reference</strong></span></a>
74                  </p>
75                </td>
76<td>
77                  <p>
78                    The type of a const reference to a value in the range.
79                  </p>
80                </td>
81</tr>
82<tr>
83<td>
84                  <p>
85                    <a class="link" href="../ip__basic_resolver_results/difference_type.html" title="ip::basic_resolver_results::difference_type"><span class="bold"><strong>difference_type</strong></span></a>
86                  </p>
87                </td>
88<td>
89                  <p>
90                    Type used to represent the distance between two iterators in
91                    the range.
92                  </p>
93                </td>
94</tr>
95<tr>
96<td>
97                  <p>
98                    <a class="link" href="../ip__basic_resolver_results/endpoint_type.html" title="ip::basic_resolver_results::endpoint_type"><span class="bold"><strong>endpoint_type</strong></span></a>
99                  </p>
100                </td>
101<td>
102                  <p>
103                    The endpoint type associated with the results.
104                  </p>
105                </td>
106</tr>
107<tr>
108<td>
109                  <p>
110                    <a class="link" href="../ip__basic_resolver_results/iterator.html" title="ip::basic_resolver_results::iterator"><span class="bold"><strong>iterator</strong></span></a>
111                  </p>
112                </td>
113<td>
114                  <p>
115                    The type of an iterator into the range.
116                  </p>
117                </td>
118</tr>
119<tr>
120<td>
121                  <p>
122                    <a class="link" href="../ip__basic_resolver_results/iterator_category.html" title="ip::basic_resolver_results::iterator_category"><span class="bold"><strong>iterator_category</strong></span></a>
123                  </p>
124                </td>
125<td>
126                  <p>
127                    The iterator category.
128                  </p>
129                </td>
130</tr>
131<tr>
132<td>
133                  <p>
134                    <a class="link" href="../ip__basic_resolver_results/pointer.html" title="ip::basic_resolver_results::pointer"><span class="bold"><strong>pointer</strong></span></a>
135                  </p>
136                </td>
137<td>
138                  <p>
139                    The type of the result of applying operator-&gt;() to the iterator.
140                  </p>
141                </td>
142</tr>
143<tr>
144<td>
145                  <p>
146                    <a class="link" href="../ip__basic_resolver_results/protocol_type.html" title="ip::basic_resolver_results::protocol_type"><span class="bold"><strong>protocol_type</strong></span></a>
147                  </p>
148                </td>
149<td>
150                  <p>
151                    The protocol type associated with the results.
152                  </p>
153                </td>
154</tr>
155<tr>
156<td>
157                  <p>
158                    <a class="link" href="../ip__basic_resolver_results/reference.html" title="ip::basic_resolver_results::reference"><span class="bold"><strong>reference</strong></span></a>
159                  </p>
160                </td>
161<td>
162                  <p>
163                    The type of a non-const reference to a value in the range.
164                  </p>
165                </td>
166</tr>
167<tr>
168<td>
169                  <p>
170                    <a class="link" href="../ip__basic_resolver_results/size_type.html" title="ip::basic_resolver_results::size_type"><span class="bold"><strong>size_type</strong></span></a>
171                  </p>
172                </td>
173<td>
174                  <p>
175                    Type used to represent a count of the elements in the range.
176                  </p>
177                </td>
178</tr>
179<tr>
180<td>
181                  <p>
182                    <a class="link" href="../ip__basic_resolver_results/value_type.html" title="ip::basic_resolver_results::value_type"><span class="bold"><strong>value_type</strong></span></a>
183                  </p>
184                </td>
185<td>
186                  <p>
187                    The type of a value in the results range.
188                  </p>
189                </td>
190</tr>
191</tbody>
192</table></div>
193<h6>
194<a name="boost_asio.reference.ip__basic_resolver.results_type.h1"></a>
195          <span class="phrase"><a name="boost_asio.reference.ip__basic_resolver.results_type.member_functions"></a></span><a class="link" href="results_type.html#boost_asio.reference.ip__basic_resolver.results_type.member_functions">Member
196          Functions</a>
197        </h6>
198<div class="informaltable"><table class="table">
199<colgroup>
200<col>
201<col>
202</colgroup>
203<thead><tr>
204<th>
205                  <p>
206                    Name
207                  </p>
208                </th>
209<th>
210                  <p>
211                    Description
212                  </p>
213                </th>
214</tr></thead>
215<tbody>
216<tr>
217<td>
218                  <p>
219                    <a class="link" href="../ip__basic_resolver_results/basic_resolver_results.html" title="ip::basic_resolver_results::basic_resolver_results"><span class="bold"><strong>basic_resolver_results</strong></span></a> <span class="silver">[constructor]</span>
220                  </p>
221                </td>
222<td>
223                  <p>
224                    Default constructor creates an empty range. <br> <span class="silver"> —</span><br> Copy
225                    constructor. <br> <span class="silver"> —</span><br> Move constructor.
226                  </p>
227                </td>
228</tr>
229<tr>
230<td>
231                  <p>
232                    <a class="link" href="../ip__basic_resolver_results/begin.html" title="ip::basic_resolver_results::begin"><span class="bold"><strong>begin</strong></span></a>
233                  </p>
234                </td>
235<td>
236                  <p>
237                    Obtain a begin iterator for the results range.
238                  </p>
239                </td>
240</tr>
241<tr>
242<td>
243                  <p>
244                    <a class="link" href="../ip__basic_resolver_results/cbegin.html" title="ip::basic_resolver_results::cbegin"><span class="bold"><strong>cbegin</strong></span></a>
245                  </p>
246                </td>
247<td>
248                  <p>
249                    Obtain a begin iterator for the results range.
250                  </p>
251                </td>
252</tr>
253<tr>
254<td>
255                  <p>
256                    <a class="link" href="../ip__basic_resolver_results/cend.html" title="ip::basic_resolver_results::cend"><span class="bold"><strong>cend</strong></span></a>
257                  </p>
258                </td>
259<td>
260                  <p>
261                    Obtain an end iterator for the results range.
262                  </p>
263                </td>
264</tr>
265<tr>
266<td>
267                  <p>
268                    <a class="link" href="../ip__basic_resolver_results/empty.html" title="ip::basic_resolver_results::empty"><span class="bold"><strong>empty</strong></span></a>
269                  </p>
270                </td>
271<td>
272                  <p>
273                    Determine whether the results range is empty.
274                  </p>
275                </td>
276</tr>
277<tr>
278<td>
279                  <p>
280                    <a class="link" href="../ip__basic_resolver_results/end.html" title="ip::basic_resolver_results::end"><span class="bold"><strong>end</strong></span></a>
281                  </p>
282                </td>
283<td>
284                  <p>
285                    Obtain an end iterator for the results range.
286                  </p>
287                </td>
288</tr>
289<tr>
290<td>
291                  <p>
292                    <a class="link" href="../ip__basic_resolver_results/max_size.html" title="ip::basic_resolver_results::max_size"><span class="bold"><strong>max_size</strong></span></a>
293                  </p>
294                </td>
295<td>
296                  <p>
297                    Get the maximum number of entries permitted in a results range.
298                  </p>
299                </td>
300</tr>
301<tr>
302<td>
303                  <p>
304                    <a class="link" href="../ip__basic_resolver_results/operator__star_.html" title="ip::basic_resolver_results::operator *"><span class="bold"><strong>operator *</strong></span></a>
305                  </p>
306                </td>
307<td>
308                  <p>
309                    Dereference an iterator.
310                  </p>
311                </td>
312</tr>
313<tr>
314<td>
315                  <p>
316                    <a class="link" href="../ip__basic_resolver_results/operator_plus__plus_.html" title="ip::basic_resolver_results::operator++"><span class="bold"><strong>operator++</strong></span></a>
317                  </p>
318                </td>
319<td>
320                  <p>
321                    Increment operator (prefix). <br> <span class="silver"> —</span><br> Increment operator
322                    (postfix).
323                  </p>
324                </td>
325</tr>
326<tr>
327<td>
328                  <p>
329                    <a class="link" href="../ip__basic_resolver_results/operator_arrow_.html" title="ip::basic_resolver_results::operator-&gt;"><span class="bold"><strong>operator-&gt;</strong></span></a>
330                  </p>
331                </td>
332<td>
333                  <p>
334                    Dereference an iterator.
335                  </p>
336                </td>
337</tr>
338<tr>
339<td>
340                  <p>
341                    <a class="link" href="../ip__basic_resolver_results/operator_eq_.html" title="ip::basic_resolver_results::operator="><span class="bold"><strong>operator=</strong></span></a>
342                  </p>
343                </td>
344<td>
345                  <p>
346                    Assignment operator. <br> <span class="silver"> —</span><br> Move-assignment operator.
347                  </p>
348                </td>
349</tr>
350<tr>
351<td>
352                  <p>
353                    <a class="link" href="../ip__basic_resolver_results/size.html" title="ip::basic_resolver_results::size"><span class="bold"><strong>size</strong></span></a>
354                  </p>
355                </td>
356<td>
357                  <p>
358                    Get the number of entries in the results range.
359                  </p>
360                </td>
361</tr>
362<tr>
363<td>
364                  <p>
365                    <a class="link" href="../ip__basic_resolver_results/swap.html" title="ip::basic_resolver_results::swap"><span class="bold"><strong>swap</strong></span></a>
366                  </p>
367                </td>
368<td>
369                  <p>
370                    Swap the results range with another.
371                  </p>
372                </td>
373</tr>
374</tbody>
375</table></div>
376<h6>
377<a name="boost_asio.reference.ip__basic_resolver.results_type.h2"></a>
378          <span class="phrase"><a name="boost_asio.reference.ip__basic_resolver.results_type.protected_member_functions"></a></span><a class="link" href="results_type.html#boost_asio.reference.ip__basic_resolver.results_type.protected_member_functions">Protected
379          Member Functions</a>
380        </h6>
381<div class="informaltable"><table class="table">
382<colgroup>
383<col>
384<col>
385</colgroup>
386<thead><tr>
387<th>
388                  <p>
389                    Name
390                  </p>
391                </th>
392<th>
393                  <p>
394                    Description
395                  </p>
396                </th>
397</tr></thead>
398<tbody>
399<tr>
400<td>
401                  <p>
402                    <a class="link" href="../ip__basic_resolver_results/dereference.html" title="ip::basic_resolver_results::dereference"><span class="bold"><strong>dereference</strong></span></a>
403                  </p>
404                </td>
405<td>
406                </td>
407</tr>
408<tr>
409<td>
410                  <p>
411                    <a class="link" href="../ip__basic_resolver_results/equal.html" title="ip::basic_resolver_results::equal"><span class="bold"><strong>equal</strong></span></a>
412                  </p>
413                </td>
414<td>
415                </td>
416</tr>
417<tr>
418<td>
419                  <p>
420                    <a class="link" href="../ip__basic_resolver_results/increment.html" title="ip::basic_resolver_results::increment"><span class="bold"><strong>increment</strong></span></a>
421                  </p>
422                </td>
423<td>
424                </td>
425</tr>
426</tbody>
427</table></div>
428<h6>
429<a name="boost_asio.reference.ip__basic_resolver.results_type.h3"></a>
430          <span class="phrase"><a name="boost_asio.reference.ip__basic_resolver.results_type.protected_data_members"></a></span><a class="link" href="results_type.html#boost_asio.reference.ip__basic_resolver.results_type.protected_data_members">Protected
431          Data Members</a>
432        </h6>
433<div class="informaltable"><table class="table">
434<colgroup>
435<col>
436<col>
437</colgroup>
438<thead><tr>
439<th>
440                  <p>
441                    Name
442                  </p>
443                </th>
444<th>
445                  <p>
446                    Description
447                  </p>
448                </th>
449</tr></thead>
450<tbody>
451<tr>
452<td>
453                  <p>
454                    <a class="link" href="../ip__basic_resolver_results/index_.html" title="ip::basic_resolver_results::index_"><span class="bold"><strong>index_</strong></span></a>
455                  </p>
456                </td>
457<td>
458                </td>
459</tr>
460<tr>
461<td>
462                  <p>
463                    <a class="link" href="../ip__basic_resolver_results/values_.html" title="ip::basic_resolver_results::values_"><span class="bold"><strong>values_</strong></span></a>
464                  </p>
465                </td>
466<td>
467                </td>
468</tr>
469</tbody>
470</table></div>
471<h6>
472<a name="boost_asio.reference.ip__basic_resolver.results_type.h4"></a>
473          <span class="phrase"><a name="boost_asio.reference.ip__basic_resolver.results_type.friends"></a></span><a class="link" href="results_type.html#boost_asio.reference.ip__basic_resolver.results_type.friends">Friends</a>
474        </h6>
475<div class="informaltable"><table class="table">
476<colgroup>
477<col>
478<col>
479</colgroup>
480<thead><tr>
481<th>
482                  <p>
483                    Name
484                  </p>
485                </th>
486<th>
487                  <p>
488                    Description
489                  </p>
490                </th>
491</tr></thead>
492<tbody>
493<tr>
494<td>
495                  <p>
496                    <a class="link" href="../ip__basic_resolver_results/operator_not__eq_.html" title="ip::basic_resolver_results::operator!="><span class="bold"><strong>operator!=</strong></span></a>
497                  </p>
498                </td>
499<td>
500                  <p>
501                    Test two iterators for inequality.
502                  </p>
503                </td>
504</tr>
505<tr>
506<td>
507                  <p>
508                    <a class="link" href="../ip__basic_resolver_results/operator_eq__eq_.html" title="ip::basic_resolver_results::operator=="><span class="bold"><strong>operator==</strong></span></a>
509                  </p>
510                </td>
511<td>
512                  <p>
513                    Test two iterators for equality.
514                  </p>
515                </td>
516</tr>
517</tbody>
518</table></div>
519<p>
520          The <a class="link" href="../ip__basic_resolver_results.html" title="ip::basic_resolver_results"><code class="computeroutput">ip::basic_resolver_results</code></a>
521          class template is used to define a range over the results returned by a
522          resolver.
523        </p>
524<p>
525          The iterator's value_type, obtained when a results iterator is dereferenced,
526          is:
527        </p>
528<pre class="programlisting">const basic_resolver_entry&lt;InternetProtocol&gt;
529</pre>
530<h6>
531<a name="boost_asio.reference.ip__basic_resolver.results_type.h5"></a>
532          <span class="phrase"><a name="boost_asio.reference.ip__basic_resolver.results_type.remarks"></a></span><a class="link" href="results_type.html#boost_asio.reference.ip__basic_resolver.results_type.remarks">Remarks</a>
533        </h6>
534<p>
535          For backward compatibility, <a class="link" href="../ip__basic_resolver_results.html" title="ip::basic_resolver_results"><code class="computeroutput">ip::basic_resolver_results</code></a>
536          is derived from <a class="link" href="../ip__basic_resolver_iterator.html" title="ip::basic_resolver_iterator"><code class="computeroutput">ip::basic_resolver_iterator</code></a>.
537          This derivation is deprecated.
538        </p>
539<h6>
540<a name="boost_asio.reference.ip__basic_resolver.results_type.h6"></a>
541          <span class="phrase"><a name="boost_asio.reference.ip__basic_resolver.results_type.thread_safety"></a></span><a class="link" href="results_type.html#boost_asio.reference.ip__basic_resolver.results_type.thread_safety">Thread
542          Safety</a>
543        </h6>
544<p>
545          <span class="emphasis"><em>Distinct</em></span> <span class="emphasis"><em>objects:</em></span> Safe.
546        </p>
547<p>
548          <span class="emphasis"><em>Shared</em></span> <span class="emphasis"><em>objects:</em></span> Unsafe.
549        </p>
550<h6>
551<a name="boost_asio.reference.ip__basic_resolver.results_type.h7"></a>
552          <span class="phrase"><a name="boost_asio.reference.ip__basic_resolver.results_type.requirements"></a></span><a class="link" href="results_type.html#boost_asio.reference.ip__basic_resolver.results_type.requirements">Requirements</a>
553        </h6>
554<p>
555          <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/ip/basic_resolver.hpp</code>
556        </p>
557<p>
558          <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code>
559        </p>
560</div>
561<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
562<td align="left"></td>
563<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M.
564      Kohlhoff<p>
565        Distributed under the Boost Software License, Version 1.0. (See accompanying
566        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>)
567      </p>
568</div></td>
569</tr></table>
570<hr>
571<div class="spirit-nav">
572<a accesskey="p" href="resolve/overload12.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../ip__basic_resolver.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="v4_mapped.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
573</div>
574</body>
575</html>
576