doc/html/boost_asio/reference/ip__basic_resolver/iterator.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>ip::basic_resolver::iterator</title>
   5 <link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.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="implementation_type.html" title="ip::basic_resolver::implementation_type">
  10 <link rel="next" href="protocol_type.html" title="ip::basic_resolver::protocol_type">
  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="implementation_type.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="protocol_type.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.iterator"></a><a class="link" href="iterator.html" title="ip::basic_resolver::iterator">ip::basic_resolver::iterator</a>
  28 </h4></div></div></div>
  29 <p>
  30           <a class="indexterm" name="idp175249008"></a>
  31 The iterator type.
  32         </p>
  33 <pre class="programlisting"><span class="keyword">typedef</span> <span class="identifier">basic_resolver_iterator</span><span class="special">&lt;</span> <span class="identifier">InternetProtocol</span> <span class="special">&gt;</span> <span class="identifier">iterator</span><span class="special">;</span>
  34 </pre>
  35 <h6>
  36 <a name="boost_asio.reference.ip__basic_resolver.iterator.h0"></a>
  37           <span class="phrase"><a name="boost_asio.reference.ip__basic_resolver.iterator.types"></a></span><a class="link" href="iterator.html#boost_asio.reference.ip__basic_resolver.iterator.types">Types</a>
  38         </h6>
  39 <div class="informaltable"><table class="table">
  40 <colgroup>
  41 <col>
  42 <col>
  43 </colgroup>
  44 <thead><tr>
  45 <th>
  46                   <p>
  47                     Name
  48                   </p>
  49                 </th>
  50 <th>
  51                   <p>
  52                     Description
  53                   </p>
  54                 </th>
  55 </tr></thead>
  56 <tbody>
  57 <tr>
  58 <td>
  59                   <p>
  60                     <a class="link" href="../ip__basic_resolver_iterator/difference_type.html" title="ip::basic_resolver_iterator::difference_type"><span class="bold"><strong>difference_type</strong></span></a>
  61                   </p>
  62                 </td>
  63 <td>
  64                   <p>
  65                     The type used for the distance between two iterators.
  66                   </p>
  67                 </td>
  68 </tr>
  69 <tr>
  70 <td>
  71                   <p>
  72                     <a class="link" href="../ip__basic_resolver_iterator/iterator_category.html" title="ip::basic_resolver_iterator::iterator_category"><span class="bold"><strong>iterator_category</strong></span></a>
  73                   </p>
  74                 </td>
  75 <td>
  76                   <p>
  77                     The iterator category.
  78                   </p>
  79                 </td>
  80 </tr>
  81 <tr>
  82 <td>
  83                   <p>
  84                     <a class="link" href="../ip__basic_resolver_iterator/pointer.html" title="ip::basic_resolver_iterator::pointer"><span class="bold"><strong>pointer</strong></span></a>
  85                   </p>
  86                 </td>
  87 <td>
  88                   <p>
  89                     The type of the result of applying operator-&gt;() to the iterator.
  90                   </p>
  91                 </td>
  92 </tr>
  93 <tr>
  94 <td>
  95                   <p>
  96                     <a class="link" href="../ip__basic_resolver_iterator/reference.html" title="ip::basic_resolver_iterator::reference"><span class="bold"><strong>reference</strong></span></a>
  97                   </p>
  98                 </td>
  99 <td>
 100                   <p>
 101                     The type of the result of applying operator*() to the iterator.
 102                   </p>
 103                 </td>
 104 </tr>
 105 <tr>
 106 <td>
 107                   <p>
 108                     <a class="link" href="../ip__basic_resolver_iterator/value_type.html" title="ip::basic_resolver_iterator::value_type"><span class="bold"><strong>value_type</strong></span></a>
 109                   </p>
 110                 </td>
 111 <td>
 112                   <p>
 113                     The type of the value pointed to by the iterator.
 114                   </p>
 115                 </td>
 116 </tr>
 117 </tbody>
 118 </table></div>
 119 <h6>
 120 <a name="boost_asio.reference.ip__basic_resolver.iterator.h1"></a>
 121           <span class="phrase"><a name="boost_asio.reference.ip__basic_resolver.iterator.member_functions"></a></span><a class="link" href="iterator.html#boost_asio.reference.ip__basic_resolver.iterator.member_functions">Member
 122           Functions</a>
 123         </h6>
 124 <div class="informaltable"><table class="table">
 125 <colgroup>
 126 <col>
 127 <col>
 128 </colgroup>
 129 <thead><tr>
 130 <th>
 131                   <p>
 132                     Name
 133                   </p>
 134                 </th>
 135 <th>
 136                   <p>
 137                     Description
 138                   </p>
 139                 </th>
 140 </tr></thead>
 141 <tbody>
 142 <tr>
 143 <td>
 144                   <p>
 145                     <a class="link" href="../ip__basic_resolver_iterator/basic_resolver_iterator.html" title="ip::basic_resolver_iterator::basic_resolver_iterator"><span class="bold"><strong>basic_resolver_iterator</strong></span></a>
 146                   </p>
 147                 </td>
 148 <td>
 149                   <p>
 150                     Default constructor creates an end iterator.
 151                   </p>
 152                 </td>
 153 </tr>
 154 <tr>
 155 <td>
 156                   <p>
 157                     <a class="link" href="../ip__basic_resolver_iterator/create.html" title="ip::basic_resolver_iterator::create"><span class="bold"><strong>create</strong></span></a>
 158                   </p>
 159                 </td>
 160 <td>
 161                   <p>
 162                     Create an iterator from an addrinfo list returned by getaddrinfo.
 163                   </p>
 164                   <p>
 165                     Create an iterator from an endpoint, host name and service name.
 166                   </p>
 167                   <p>
 168                     Create an iterator from a sequence of endpoints, host and service
 169                     name.
 170                   </p>
 171                 </td>
 172 </tr>
 173 <tr>
 174 <td>
 175                   <p>
 176                     <a class="link" href="../ip__basic_resolver_iterator/operator__star_.html" title="ip::basic_resolver_iterator::operator *"><span class="bold"><strong>operator *</strong></span></a>
 177                   </p>
 178                 </td>
 179 <td>
 180                   <p>
 181                     Dereference an iterator.
 182                   </p>
 183                 </td>
 184 </tr>
 185 <tr>
 186 <td>
 187                   <p>
 188                     <a class="link" href="../ip__basic_resolver_iterator/operator_plus__plus_.html" title="ip::basic_resolver_iterator::operator++"><span class="bold"><strong>operator++</strong></span></a>
 189                   </p>
 190                 </td>
 191 <td>
 192                   <p>
 193                     Increment operator (prefix).
 194                   </p>
 195                   <p>
 196                     Increment operator (postfix).
 197                   </p>
 198                 </td>
 199 </tr>
 200 <tr>
 201 <td>
 202                   <p>
 203                     <a class="link" href="../ip__basic_resolver_iterator/operator_arrow_.html" title="ip::basic_resolver_iterator::operator-&gt;"><span class="bold"><strong>operator-&gt;</strong></span></a>
 204                   </p>
 205                 </td>
 206 <td>
 207                   <p>
 208                     Dereference an iterator.
 209                   </p>
 210                 </td>
 211 </tr>
 212 </tbody>
 213 </table></div>
 214 <h6>
 215 <a name="boost_asio.reference.ip__basic_resolver.iterator.h2"></a>
 216           <span class="phrase"><a name="boost_asio.reference.ip__basic_resolver.iterator.friends"></a></span><a class="link" href="iterator.html#boost_asio.reference.ip__basic_resolver.iterator.friends">Friends</a>
 217         </h6>
 218 <div class="informaltable"><table class="table">
 219 <colgroup>
 220 <col>
 221 <col>
 222 </colgroup>
 223 <thead><tr>
 224 <th>
 225                   <p>
 226                     Name
 227                   </p>
 228                 </th>
 229 <th>
 230                   <p>
 231                     Description
 232                   </p>
 233                 </th>
 234 </tr></thead>
 235 <tbody>
 236 <tr>
 237 <td>
 238                   <p>
 239                     <a class="link" href="../ip__basic_resolver_iterator/operator_not__eq_.html" title="ip::basic_resolver_iterator::operator!="><span class="bold"><strong>operator!=</strong></span></a>
 240                   </p>
 241                 </td>
 242 <td>
 243                   <p>
 244                     Test two iterators for inequality.
 245                   </p>
 246                 </td>
 247 </tr>
 248 <tr>
 249 <td>
 250                   <p>
 251                     <a class="link" href="../ip__basic_resolver_iterator/operator_eq__eq_.html" title="ip::basic_resolver_iterator::operator=="><span class="bold"><strong>operator==</strong></span></a>
 252                   </p>
 253                 </td>
 254 <td>
 255                   <p>
 256                     Test two iterators for equality.
 257                   </p>
 258                 </td>
 259 </tr>
 260 </tbody>
 261 </table></div>
 262 <p>
 263           The <a class="link" href="../ip__basic_resolver_iterator.html" title="ip::basic_resolver_iterator"><code class="computeroutput"><span class="identifier">ip</span><span class="special">::</span><span class="identifier">basic_resolver_iterator</span></code></a> class
 264           template is used to define iterators over the results returned by a resolver.
 265         </p>
 266 <p>
 267           The iterator's value_type, obtained when the iterator is dereferenced,
 268           is:
 269         </p>
 270 <pre class="programlisting"><span class="keyword">const</span> <span class="identifier">basic_resolver_entry</span><span class="special">&lt;</span><span class="identifier">InternetProtocol</span><span class="special">&gt;</span>
 271 </pre>
 272 <h6>
 273 <a name="boost_asio.reference.ip__basic_resolver.iterator.h3"></a>
 274           <span class="phrase"><a name="boost_asio.reference.ip__basic_resolver.iterator.thread_safety"></a></span><a class="link" href="iterator.html#boost_asio.reference.ip__basic_resolver.iterator.thread_safety">Thread
 275           Safety</a>
 276         </h6>
 277 <p>
 278           <span class="emphasis"><em>Distinct</em></span> <span class="emphasis"><em>objects:</em></span> Safe.
 279         </p>
 280 <p>
 281           <span class="emphasis"><em>Shared</em></span> <span class="emphasis"><em>objects:</em></span> Unsafe.
 282         </p>
 283 <h6>
 284 <a name="boost_asio.reference.ip__basic_resolver.iterator.h4"></a>
 285           <span class="phrase"><a name="boost_asio.reference.ip__basic_resolver.iterator.requirements"></a></span><a class="link" href="iterator.html#boost_asio.reference.ip__basic_resolver.iterator.requirements">Requirements</a>
 286         </h6>
 287 <p>
 288           <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/ip/basic_resolver.hpp</code>
 289         </p>
 290 <p>
 291           <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code>
 292         </p>
 293 </div>
 294 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 295 <td align="left"></td>
 296 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2014 Christopher M. Kohlhoff<p>
 297         Distributed under the Boost Software License, Version 1.0. (See accompanying
 298         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>)
 299       </p>
 300 </div></td>
 301 </tr></table>
 302 <hr>
 303 <div class="spirit-nav">
 304 <a accesskey="p" href="implementation_type.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="protocol_type.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
 305 </div>
 306 </body>
 307 </html>