doc/html/boost_asio/reference/ip__basic_resolver.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>ip::basic_resolver</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="../reference.html" title="Reference">
   9 <link rel="prev" href="ip__basic_endpoint/size.html" title="ip::basic_endpoint::size">
  10 <link rel="next" href="ip__basic_resolver/async_resolve.html" title="ip::basic_resolver::async_resolve">
  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_endpoint/size.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/async_resolve.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"></a><a class="link" href="ip__basic_resolver.html" title="ip::basic_resolver">ip::basic_resolver</a>
  28 </h3></div></div></div>
  29 <p>
  30         Provides endpoint resolution functionality.
  31       </p>
  32 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
  33     <span class="keyword">typename</span> <a class="link" href="InternetProtocol.html" title="Internet protocol requirements">InternetProtocol</a><span class="special">,</span>
  34     <span class="keyword">typename</span> <a class="link" href="ResolverService.html" title="Resolver service requirements">ResolverService</a> <span class="special">=</span> <span class="identifier">resolver_service</span><span class="special">&lt;</span><span class="identifier">InternetProtocol</span><span class="special">&gt;&gt;</span>
  35 <span class="keyword">class</span> <span class="identifier">basic_resolver</span> <span class="special">:</span>
  36   <span class="keyword">public</span> <span class="identifier">basic_io_object</span><span class="special">&lt;</span> <span class="identifier">ResolverService</span> <span class="special">&gt;</span>
  37 </pre>
  38 <h5>
  39 <a name="boost_asio.reference.ip__basic_resolver.h0"></a>
  40         <span class="phrase"><a name="boost_asio.reference.ip__basic_resolver.types"></a></span><a class="link" href="ip__basic_resolver.html#boost_asio.reference.ip__basic_resolver.types">Types</a>
  41       </h5>
  42 <div class="informaltable"><table class="table">
  43 <colgroup>
  44 <col>
  45 <col>
  46 </colgroup>
  47 <thead><tr>
  48 <th>
  49                 <p>
  50                   Name
  51                 </p>
  52               </th>
  53 <th>
  54                 <p>
  55                   Description
  56                 </p>
  57               </th>
  58 </tr></thead>
  59 <tbody>
  60 <tr>
  61 <td>
  62                 <p>
  63                   <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>
  64                 </p>
  65               </td>
  66 <td>
  67                 <p>
  68                   The endpoint type.
  69                 </p>
  70               </td>
  71 </tr>
  72 <tr>
  73 <td>
  74                 <p>
  75                   <a class="link" href="ip__basic_resolver/implementation_type.html" title="ip::basic_resolver::implementation_type"><span class="bold"><strong>implementation_type</strong></span></a>
  76                 </p>
  77               </td>
  78 <td>
  79                 <p>
  80                   The underlying implementation type of I/O object.
  81                 </p>
  82               </td>
  83 </tr>
  84 <tr>
  85 <td>
  86                 <p>
  87                   <a class="link" href="ip__basic_resolver/iterator.html" title="ip::basic_resolver::iterator"><span class="bold"><strong>iterator</strong></span></a>
  88                 </p>
  89               </td>
  90 <td>
  91                 <p>
  92                   The iterator type.
  93                 </p>
  94               </td>
  95 </tr>
  96 <tr>
  97 <td>
  98                 <p>
  99                   <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>
 100                 </p>
 101               </td>
 102 <td>
 103                 <p>
 104                   The protocol type.
 105                 </p>
 106               </td>
 107 </tr>
 108 <tr>
 109 <td>
 110                 <p>
 111                   <a class="link" href="ip__basic_resolver/query.html" title="ip::basic_resolver::query"><span class="bold"><strong>query</strong></span></a>
 112                 </p>
 113               </td>
 114 <td>
 115                 <p>
 116                   The query type.
 117                 </p>
 118               </td>
 119 </tr>
 120 <tr>
 121 <td>
 122                 <p>
 123                   <a class="link" href="ip__basic_resolver/service_type.html" title="ip::basic_resolver::service_type"><span class="bold"><strong>service_type</strong></span></a>
 124                 </p>
 125               </td>
 126 <td>
 127                 <p>
 128                   The type of the service that will be used to provide I/O operations.
 129                 </p>
 130               </td>
 131 </tr>
 132 </tbody>
 133 </table></div>
 134 <h5>
 135 <a name="boost_asio.reference.ip__basic_resolver.h1"></a>
 136         <span class="phrase"><a name="boost_asio.reference.ip__basic_resolver.member_functions"></a></span><a class="link" href="ip__basic_resolver.html#boost_asio.reference.ip__basic_resolver.member_functions">Member
 137         Functions</a>
 138       </h5>
 139 <div class="informaltable"><table class="table">
 140 <colgroup>
 141 <col>
 142 <col>
 143 </colgroup>
 144 <thead><tr>
 145 <th>
 146                 <p>
 147                   Name
 148                 </p>
 149               </th>
 150 <th>
 151                 <p>
 152                   Description
 153                 </p>
 154               </th>
 155 </tr></thead>
 156 <tbody>
 157 <tr>
 158 <td>
 159                 <p>
 160                   <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>
 161                 </p>
 162               </td>
 163 <td>
 164                 <p>
 165                   Asynchronously perform forward resolution of a query to a list
 166                   of entries.
 167                 </p>
 168                 <p>
 169                   Asynchronously perform reverse resolution of an endpoint to a list
 170                   of entries.
 171                 </p>
 172               </td>
 173 </tr>
 174 <tr>
 175 <td>
 176                 <p>
 177                   <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>
 178                 </p>
 179               </td>
 180 <td>
 181                 <p>
 182                   Constructor.
 183                 </p>
 184               </td>
 185 </tr>
 186 <tr>
 187 <td>
 188                 <p>
 189                   <a class="link" href="ip__basic_resolver/cancel.html" title="ip::basic_resolver::cancel"><span class="bold"><strong>cancel</strong></span></a>
 190                 </p>
 191               </td>
 192 <td>
 193                 <p>
 194                   Cancel any asynchronous operations that are waiting on the resolver.
 195                 </p>
 196               </td>
 197 </tr>
 198 <tr>
 199 <td>
 200                 <p>
 201                   <a class="link" href="ip__basic_resolver/get_io_service.html" title="ip::basic_resolver::get_io_service"><span class="bold"><strong>get_io_service</strong></span></a>
 202                 </p>
 203               </td>
 204 <td>
 205                 <p>
 206                   Get the io_service associated with the object.
 207                 </p>
 208               </td>
 209 </tr>
 210 <tr>
 211 <td>
 212                 <p>
 213                   <a class="link" href="ip__basic_resolver/resolve.html" title="ip::basic_resolver::resolve"><span class="bold"><strong>resolve</strong></span></a>
 214                 </p>
 215               </td>
 216 <td>
 217                 <p>
 218                   Perform forward resolution of a query to a list of entries.
 219                 </p>
 220                 <p>
 221                   Perform reverse resolution of an endpoint to a list of entries.
 222                 </p>
 223               </td>
 224 </tr>
 225 </tbody>
 226 </table></div>
 227 <h5>
 228 <a name="boost_asio.reference.ip__basic_resolver.h2"></a>
 229         <span class="phrase"><a name="boost_asio.reference.ip__basic_resolver.protected_member_functions"></a></span><a class="link" href="ip__basic_resolver.html#boost_asio.reference.ip__basic_resolver.protected_member_functions">Protected
 230         Member Functions</a>
 231       </h5>
 232 <div class="informaltable"><table class="table">
 233 <colgroup>
 234 <col>
 235 <col>
 236 </colgroup>
 237 <thead><tr>
 238 <th>
 239                 <p>
 240                   Name
 241                 </p>
 242               </th>
 243 <th>
 244                 <p>
 245                   Description
 246                 </p>
 247               </th>
 248 </tr></thead>
 249 <tbody>
 250 <tr>
 251 <td>
 252                 <p>
 253                   <a class="link" href="ip__basic_resolver/get_implementation.html" title="ip::basic_resolver::get_implementation"><span class="bold"><strong>get_implementation</strong></span></a>
 254                 </p>
 255               </td>
 256 <td>
 257                 <p>
 258                   Get the underlying implementation of the I/O object.
 259                 </p>
 260               </td>
 261 </tr>
 262 <tr>
 263 <td>
 264                 <p>
 265                   <a class="link" href="ip__basic_resolver/get_service.html" title="ip::basic_resolver::get_service"><span class="bold"><strong>get_service</strong></span></a>
 266                 </p>
 267               </td>
 268 <td>
 269                 <p>
 270                   Get the service associated with the I/O object.
 271                 </p>
 272               </td>
 273 </tr>
 274 </tbody>
 275 </table></div>
 276 <h5>
 277 <a name="boost_asio.reference.ip__basic_resolver.h3"></a>
 278         <span class="phrase"><a name="boost_asio.reference.ip__basic_resolver.protected_data_members"></a></span><a class="link" href="ip__basic_resolver.html#boost_asio.reference.ip__basic_resolver.protected_data_members">Protected
 279         Data Members</a>
 280       </h5>
 281 <div class="informaltable"><table class="table">
 282 <colgroup>
 283 <col>
 284 <col>
 285 </colgroup>
 286 <thead><tr>
 287 <th>
 288                 <p>
 289                   Name
 290                 </p>
 291               </th>
 292 <th>
 293                 <p>
 294                   Description
 295                 </p>
 296               </th>
 297 </tr></thead>
 298 <tbody>
 299 <tr>
 300 <td>
 301                 <p>
 302                   <a class="link" href="ip__basic_resolver/implementation.html" title="ip::basic_resolver::implementation"><span class="bold"><strong>implementation</strong></span></a>
 303                 </p>
 304               </td>
 305 <td>
 306                 <p>
 307                   (Deprecated: Use get_implementation().) The underlying implementation
 308                   of the I/O object.
 309                 </p>
 310               </td>
 311 </tr>
 312 <tr>
 313 <td>
 314                 <p>
 315                   <a class="link" href="ip__basic_resolver/service.html" title="ip::basic_resolver::service"><span class="bold"><strong>service</strong></span></a>
 316                 </p>
 317               </td>
 318 <td>
 319                 <p>
 320                   (Deprecated: Use get_service().) The service associated with the
 321                   I/O object.
 322                 </p>
 323               </td>
 324 </tr>
 325 </tbody>
 326 </table></div>
 327 <p>
 328         The <a class="link" href="ip__basic_resolver.html" title="ip::basic_resolver"><code class="computeroutput"><span class="identifier">ip</span><span class="special">::</span><span class="identifier">basic_resolver</span></code></a>
 329         class template provides the ability to resolve a query to a list of endpoints.
 330       </p>
 331 <h5>
 332 <a name="boost_asio.reference.ip__basic_resolver.h4"></a>
 333         <span class="phrase"><a name="boost_asio.reference.ip__basic_resolver.thread_safety"></a></span><a class="link" href="ip__basic_resolver.html#boost_asio.reference.ip__basic_resolver.thread_safety">Thread Safety</a>
 334       </h5>
 335 <p>
 336         <span class="emphasis"><em>Distinct</em></span> <span class="emphasis"><em>objects:</em></span> Safe.
 337       </p>
 338 <p>
 339         <span class="emphasis"><em>Shared</em></span> <span class="emphasis"><em>objects:</em></span> Unsafe.
 340       </p>
 341 <h5>
 342 <a name="boost_asio.reference.ip__basic_resolver.h5"></a>
 343         <span class="phrase"><a name="boost_asio.reference.ip__basic_resolver.requirements"></a></span><a class="link" href="ip__basic_resolver.html#boost_asio.reference.ip__basic_resolver.requirements">Requirements</a>
 344       </h5>
 345 <p>
 346         <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/ip/basic_resolver.hpp</code>
 347       </p>
 348 <p>
 349         <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code>
 350       </p>
 351 </div>
 352 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 353 <td align="left"></td>
 354 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2014 Christopher M. Kohlhoff<p>
 355         Distributed under the Boost Software License, Version 1.0. (See accompanying
 356         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>)
 357       </p>
 358 </div></td>
 359 </tr></table>
 360 <hr>
 361 <div class="spirit-nav">
 362 <a accesskey="p" href="ip__basic_endpoint/size.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/async_resolve.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 363 </div>
 364 </body>
 365 </html>