1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>ip::basic_resolver_results</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="../reference.html" title="Reference"> 9<link rel="prev" href="ip__basic_resolver_query/v4_mapped.html" title="ip::basic_resolver_query::v4_mapped"> 10<link rel="next" href="ip__basic_resolver_results/basic_resolver_results.html" title="ip::basic_resolver_results::basic_resolver_results"> 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="ip__basic_resolver_query/v4_mapped.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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="ip__basic_resolver_results/basic_resolver_results.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="section"> 26<div class="titlepage"><div><div><h3 class="title"> 27<a name="boost_asio.reference.ip__basic_resolver_results"></a><a class="link" href="ip__basic_resolver_results.html" title="ip::basic_resolver_results">ip::basic_resolver_results</a> 28</h3></div></div></div> 29<p> 30 A range of entries produced by a resolver. 31 </p> 32<pre class="programlisting">template< 33 typename <a class="link" href="InternetProtocol.html" title="Internet protocol requirements">InternetProtocol</a>> 34class basic_resolver_results : 35 public ip::basic_resolver_iterator< InternetProtocol > 36</pre> 37<h5> 38<a name="boost_asio.reference.ip__basic_resolver_results.h0"></a> 39 <span class="phrase"><a name="boost_asio.reference.ip__basic_resolver_results.types"></a></span><a class="link" href="ip__basic_resolver_results.html#boost_asio.reference.ip__basic_resolver_results.types">Types</a> 40 </h5> 41<div class="informaltable"><table class="table"> 42<colgroup> 43<col> 44<col> 45</colgroup> 46<thead><tr> 47<th> 48 <p> 49 Name 50 </p> 51 </th> 52<th> 53 <p> 54 Description 55 </p> 56 </th> 57</tr></thead> 58<tbody> 59<tr> 60<td> 61 <p> 62 <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> 63 </p> 64 </td> 65<td> 66 <p> 67 The type of an iterator into the range. 68 </p> 69 </td> 70</tr> 71<tr> 72<td> 73 <p> 74 <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> 75 </p> 76 </td> 77<td> 78 <p> 79 The type of a const reference to a value in the range. 80 </p> 81 </td> 82</tr> 83<tr> 84<td> 85 <p> 86 <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> 87 </p> 88 </td> 89<td> 90 <p> 91 Type used to represent the distance between two iterators in the 92 range. 93 </p> 94 </td> 95</tr> 96<tr> 97<td> 98 <p> 99 <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> 100 </p> 101 </td> 102<td> 103 <p> 104 The endpoint type associated with the results. 105 </p> 106 </td> 107</tr> 108<tr> 109<td> 110 <p> 111 <a class="link" href="ip__basic_resolver_results/iterator.html" title="ip::basic_resolver_results::iterator"><span class="bold"><strong>iterator</strong></span></a> 112 </p> 113 </td> 114<td> 115 <p> 116 The type of an iterator into the range. 117 </p> 118 </td> 119</tr> 120<tr> 121<td> 122 <p> 123 <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> 124 </p> 125 </td> 126<td> 127 <p> 128 The iterator category. 129 </p> 130 </td> 131</tr> 132<tr> 133<td> 134 <p> 135 <a class="link" href="ip__basic_resolver_results/pointer.html" title="ip::basic_resolver_results::pointer"><span class="bold"><strong>pointer</strong></span></a> 136 </p> 137 </td> 138<td> 139 <p> 140 The type of the result of applying operator->() to the iterator. 141 </p> 142 </td> 143</tr> 144<tr> 145<td> 146 <p> 147 <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> 148 </p> 149 </td> 150<td> 151 <p> 152 The protocol type associated with the results. 153 </p> 154 </td> 155</tr> 156<tr> 157<td> 158 <p> 159 <a class="link" href="ip__basic_resolver_results/reference.html" title="ip::basic_resolver_results::reference"><span class="bold"><strong>reference</strong></span></a> 160 </p> 161 </td> 162<td> 163 <p> 164 The type of a non-const reference to a value in the range. 165 </p> 166 </td> 167</tr> 168<tr> 169<td> 170 <p> 171 <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> 172 </p> 173 </td> 174<td> 175 <p> 176 Type used to represent a count of the elements in the range. 177 </p> 178 </td> 179</tr> 180<tr> 181<td> 182 <p> 183 <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> 184 </p> 185 </td> 186<td> 187 <p> 188 The type of a value in the results range. 189 </p> 190 </td> 191</tr> 192</tbody> 193</table></div> 194<h5> 195<a name="boost_asio.reference.ip__basic_resolver_results.h1"></a> 196 <span class="phrase"><a name="boost_asio.reference.ip__basic_resolver_results.member_functions"></a></span><a class="link" href="ip__basic_resolver_results.html#boost_asio.reference.ip__basic_resolver_results.member_functions">Member 197 Functions</a> 198 </h5> 199<div class="informaltable"><table class="table"> 200<colgroup> 201<col> 202<col> 203</colgroup> 204<thead><tr> 205<th> 206 <p> 207 Name 208 </p> 209 </th> 210<th> 211 <p> 212 Description 213 </p> 214 </th> 215</tr></thead> 216<tbody> 217<tr> 218<td> 219 <p> 220 <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> 221 </p> 222 </td> 223<td> 224 <p> 225 Default constructor creates an empty range. <br> <span class="silver"> —</span><br> Copy 226 constructor. <br> <span class="silver"> —</span><br> Move constructor. 227 </p> 228 </td> 229</tr> 230<tr> 231<td> 232 <p> 233 <a class="link" href="ip__basic_resolver_results/begin.html" title="ip::basic_resolver_results::begin"><span class="bold"><strong>begin</strong></span></a> 234 </p> 235 </td> 236<td> 237 <p> 238 Obtain a begin iterator for the results range. 239 </p> 240 </td> 241</tr> 242<tr> 243<td> 244 <p> 245 <a class="link" href="ip__basic_resolver_results/cbegin.html" title="ip::basic_resolver_results::cbegin"><span class="bold"><strong>cbegin</strong></span></a> 246 </p> 247 </td> 248<td> 249 <p> 250 Obtain a begin iterator for the results range. 251 </p> 252 </td> 253</tr> 254<tr> 255<td> 256 <p> 257 <a class="link" href="ip__basic_resolver_results/cend.html" title="ip::basic_resolver_results::cend"><span class="bold"><strong>cend</strong></span></a> 258 </p> 259 </td> 260<td> 261 <p> 262 Obtain an end iterator for the results range. 263 </p> 264 </td> 265</tr> 266<tr> 267<td> 268 <p> 269 <a class="link" href="ip__basic_resolver_results/empty.html" title="ip::basic_resolver_results::empty"><span class="bold"><strong>empty</strong></span></a> 270 </p> 271 </td> 272<td> 273 <p> 274 Determine whether the results range is empty. 275 </p> 276 </td> 277</tr> 278<tr> 279<td> 280 <p> 281 <a class="link" href="ip__basic_resolver_results/end.html" title="ip::basic_resolver_results::end"><span class="bold"><strong>end</strong></span></a> 282 </p> 283 </td> 284<td> 285 <p> 286 Obtain an end iterator for the results range. 287 </p> 288 </td> 289</tr> 290<tr> 291<td> 292 <p> 293 <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> 294 </p> 295 </td> 296<td> 297 <p> 298 Get the maximum number of entries permitted in a results range. 299 </p> 300 </td> 301</tr> 302<tr> 303<td> 304 <p> 305 <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> 306 </p> 307 </td> 308<td> 309 <p> 310 Dereference an iterator. 311 </p> 312 </td> 313</tr> 314<tr> 315<td> 316 <p> 317 <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> 318 </p> 319 </td> 320<td> 321 <p> 322 Increment operator (prefix). <br> <span class="silver"> —</span><br> Increment operator (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->"><span class="bold"><strong>operator-></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<h5> 377<a name="boost_asio.reference.ip__basic_resolver_results.h2"></a> 378 <span class="phrase"><a name="boost_asio.reference.ip__basic_resolver_results.protected_member_functions"></a></span><a class="link" href="ip__basic_resolver_results.html#boost_asio.reference.ip__basic_resolver_results.protected_member_functions">Protected 379 Member Functions</a> 380 </h5> 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<h5> 429<a name="boost_asio.reference.ip__basic_resolver_results.h3"></a> 430 <span class="phrase"><a name="boost_asio.reference.ip__basic_resolver_results.protected_data_members"></a></span><a class="link" href="ip__basic_resolver_results.html#boost_asio.reference.ip__basic_resolver_results.protected_data_members">Protected 431 Data Members</a> 432 </h5> 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<h5> 472<a name="boost_asio.reference.ip__basic_resolver_results.h4"></a> 473 <span class="phrase"><a name="boost_asio.reference.ip__basic_resolver_results.friends"></a></span><a class="link" href="ip__basic_resolver_results.html#boost_asio.reference.ip__basic_resolver_results.friends">Friends</a> 474 </h5> 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 resolver. 522 </p> 523<p> 524 The iterator's value_type, obtained when a results iterator is dereferenced, 525 is: 526 </p> 527<pre class="programlisting">const basic_resolver_entry<InternetProtocol> 528</pre> 529<h5> 530<a name="boost_asio.reference.ip__basic_resolver_results.h5"></a> 531 <span class="phrase"><a name="boost_asio.reference.ip__basic_resolver_results.remarks"></a></span><a class="link" href="ip__basic_resolver_results.html#boost_asio.reference.ip__basic_resolver_results.remarks">Remarks</a> 532 </h5> 533<p> 534 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> 535 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>. 536 This derivation is deprecated. 537 </p> 538<h5> 539<a name="boost_asio.reference.ip__basic_resolver_results.h6"></a> 540 <span class="phrase"><a name="boost_asio.reference.ip__basic_resolver_results.thread_safety"></a></span><a class="link" href="ip__basic_resolver_results.html#boost_asio.reference.ip__basic_resolver_results.thread_safety">Thread 541 Safety</a> 542 </h5> 543<p> 544 <span class="emphasis"><em>Distinct</em></span> <span class="emphasis"><em>objects:</em></span> Safe. 545 </p> 546<p> 547 <span class="emphasis"><em>Shared</em></span> <span class="emphasis"><em>objects:</em></span> Unsafe. 548 </p> 549<h5> 550<a name="boost_asio.reference.ip__basic_resolver_results.h7"></a> 551 <span class="phrase"><a name="boost_asio.reference.ip__basic_resolver_results.requirements"></a></span><a class="link" href="ip__basic_resolver_results.html#boost_asio.reference.ip__basic_resolver_results.requirements">Requirements</a> 552 </h5> 553<p> 554 <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/ip/basic_resolver_results.hpp</code> 555 </p> 556<p> 557 <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code> 558 </p> 559</div> 560<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 561<td align="left"></td> 562<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M. 563 Kohlhoff<p> 564 Distributed under the Boost Software License, Version 1.0. (See accompanying 565 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>) 566 </p> 567</div></td> 568</tr></table> 569<hr> 570<div class="spirit-nav"> 571<a accesskey="p" href="ip__basic_resolver_query/v4_mapped.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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="ip__basic_resolver_results/basic_resolver_results.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 572</div> 573</body> 574</html> 575
