ResolverService.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229
  1. <html>
  2. <head>
  3. <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
  4. <title>Resolver service requirements</title>
  5. <link rel="stylesheet" href="../../boostbook.css" type="text/css">
  6. <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
  7. <link rel="home" href="../../index.html" title="Asio">
  8. <link rel="up" href="../reference.html" title="Reference">
  9. <link rel="prev" href="ResolveHandler.html" title="Resolve handler requirements">
  10. <link rel="next" href="SeqPacketSocketService.html" title="Sequenced packet socket service requirements">
  11. </head>
  12. <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13. <table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../asio.png"></td></tr></table>
  14. <hr>
  15. <div class="spirit-nav">
  16. <a accesskey="p" href="ResolveHandler.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="SeqPacketSocketService.html"><img src="../../next.png" alt="Next"></a>
  17. </div>
  18. <div class="section">
  19. <div class="titlepage"><div><div><h3 class="title">
  20. <a name="asio.reference.ResolverService"></a><a class="link" href="ResolverService.html" title="Resolver service requirements">Resolver service requirements</a>
  21. </h3></div></div></div>
  22. <p>
  23. A resolver service must meet the requirements for an <a class="link" href="IoObjectService.html" title="I/O object service requirements">I/O
  24. object service</a>, as well as the additional requirements listed below.
  25. </p>
  26. <p>
  27. In the table below, <code class="computeroutput"><span class="identifier">X</span></code> denotes
  28. a resolver service class for protocol <code class="computeroutput"><span class="identifier">InternetProtocol</span></code>,
  29. <code class="computeroutput"><span class="identifier">a</span></code> denotes a value of type
  30. <code class="computeroutput"><span class="identifier">X</span></code>, <code class="computeroutput"><span class="identifier">b</span></code>
  31. denotes a value of type <code class="computeroutput"><span class="identifier">X</span><span class="special">::</span><span class="identifier">implementation_type</span></code>,
  32. <code class="computeroutput"><span class="identifier">q</span></code> denotes a value of type
  33. <code class="computeroutput"><span class="identifier">ip</span><span class="special">::</span><span class="identifier">basic_resolver_query</span><span class="special">&lt;</span><span class="identifier">InternetProtocol</span><span class="special">&gt;</span></code>,
  34. <code class="computeroutput"><span class="identifier">e</span></code> denotes a value of type
  35. <code class="computeroutput"><span class="identifier">ip</span><span class="special">::</span><span class="identifier">basic_endpoint</span><span class="special">&lt;</span><span class="identifier">InternetProtocol</span><span class="special">&gt;</span></code>,
  36. <code class="computeroutput"><span class="identifier">ec</span></code> denotes a value of type
  37. <code class="computeroutput"><span class="identifier">error_code</span></code>, and <code class="computeroutput"><span class="identifier">h</span></code> denotes a value meeting <a class="link" href="ResolveHandler.html" title="Resolve handler requirements"><code class="computeroutput"><span class="identifier">ResolveHandler</span></code></a> requirements.
  38. </p>
  39. <div class="table">
  40. <a name="asio.reference.ResolverService.t0"></a><p class="title"><b>Table&#160;23.&#160;ResolverService requirements</b></p>
  41. <div class="table-contents"><table class="table" summary="ResolverService requirements">
  42. <colgroup>
  43. <col>
  44. <col>
  45. <col>
  46. </colgroup>
  47. <thead><tr>
  48. <th>
  49. <p>
  50. expression
  51. </p>
  52. </th>
  53. <th>
  54. <p>
  55. return type
  56. </p>
  57. </th>
  58. <th>
  59. <p>
  60. assertion/note<br> pre/post-condition
  61. </p>
  62. </th>
  63. </tr></thead>
  64. <tbody>
  65. <tr>
  66. <td>
  67. <p>
  68. <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">destroy</span><span class="special">(</span><span class="identifier">b</span><span class="special">);</span></code>
  69. </p>
  70. </td>
  71. <td>
  72. </td>
  73. <td>
  74. <p>
  75. From <a class="link" href="IoObjectService.html" title="I/O object service requirements">IoObjectService</a>
  76. requirements. Implicitly cancels asynchronous resolve operations,
  77. as if by calling <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">cancel</span><span class="special">(</span><span class="identifier">b</span><span class="special">,</span> <span class="identifier">ec</span><span class="special">)</span></code>.
  78. </p>
  79. </td>
  80. </tr>
  81. <tr>
  82. <td>
  83. <p>
  84. </p>
  85. <pre class="programlisting"><span class="identifier">a</span><span class="special">.</span><span class="identifier">cancel</span><span class="special">(</span><span class="identifier">b</span><span class="special">,</span> <span class="identifier">ec</span><span class="special">);</span>
  86. </pre>
  87. <p>
  88. </p>
  89. </td>
  90. <td>
  91. <p>
  92. <code class="computeroutput"><span class="identifier">error_code</span></code>
  93. </p>
  94. </td>
  95. <td>
  96. <p>
  97. Causes any outstanding asynchronous resolve operations to complete
  98. as soon as possible. Handlers for cancelled operations shall be
  99. passed the error code <code class="computeroutput"><span class="identifier">error</span><span class="special">::</span><span class="identifier">operation_aborted</span></code>.
  100. </p>
  101. </td>
  102. </tr>
  103. <tr>
  104. <td>
  105. <p>
  106. </p>
  107. <pre class="programlisting"><span class="identifier">a</span><span class="special">.</span><span class="identifier">resolve</span><span class="special">(</span><span class="identifier">b</span><span class="special">,</span> <span class="identifier">q</span><span class="special">,</span> <span class="identifier">ec</span><span class="special">);</span>
  108. </pre>
  109. <p>
  110. </p>
  111. </td>
  112. <td>
  113. <p>
  114. </p>
  115. <pre class="programlisting"><span class="identifier">ip</span><span class="special">::</span><span class="identifier">basic_resolver_iterator</span><span class="special">&lt;</span>
  116. <span class="identifier">InternetProtocol</span><span class="special">&gt;</span>
  117. </pre>
  118. <p>
  119. </p>
  120. </td>
  121. <td>
  122. <p>
  123. On success, returns an iterator <code class="computeroutput"><span class="identifier">i</span></code>
  124. such that <code class="computeroutput"><span class="identifier">i</span> <span class="special">!=</span>
  125. <span class="identifier">ip</span><span class="special">::</span><span class="identifier">basic_resolver_iterator</span><span class="special">&lt;</span><span class="identifier">InternetProtocol</span><span class="special">&gt;()</span></code>.
  126. Otherwise returns <code class="computeroutput"><span class="identifier">ip</span><span class="special">::</span><span class="identifier">basic_resolver_iterator</span><span class="special">&lt;</span><span class="identifier">InternetProtocol</span><span class="special">&gt;()</span></code>.
  127. </p>
  128. </td>
  129. </tr>
  130. <tr>
  131. <td>
  132. <p>
  133. </p>
  134. <pre class="programlisting"><span class="identifier">a</span><span class="special">.</span><span class="identifier">async_resolve</span><span class="special">(</span><span class="identifier">b</span><span class="special">,</span> <span class="identifier">q</span><span class="special">,</span> <span class="identifier">h</span><span class="special">);</span>
  135. </pre>
  136. <p>
  137. </p>
  138. </td>
  139. <td>
  140. </td>
  141. <td>
  142. <p>
  143. Initiates an asynchronous resolve operation that is performed via
  144. the <code class="computeroutput"><span class="identifier">io_service</span></code>
  145. object <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">get_io_service</span><span class="special">()</span></code>
  146. and behaves according to <a class="link" href="asynchronous_operations.html" title="Requirements on asynchronous operations">asynchronous
  147. operation</a> requirements.<br> <br> If the operation completes
  148. successfully, the <code class="computeroutput"><span class="identifier">ResolveHandler</span></code>
  149. object <code class="computeroutput"><span class="identifier">h</span></code> shall
  150. be invoked with an iterator object <code class="computeroutput"><span class="identifier">i</span></code>
  151. such that the condition <code class="computeroutput"><span class="identifier">i</span>
  152. <span class="special">!=</span> <span class="identifier">ip</span><span class="special">::</span><span class="identifier">basic_resolver_iterator</span><span class="special">&lt;</span><span class="identifier">InternetProtocol</span><span class="special">&gt;()</span></code> holds. Otherwise it is invoked
  153. with <code class="computeroutput"><span class="identifier">ip</span><span class="special">::</span><span class="identifier">basic_resolver_iterator</span><span class="special">&lt;</span><span class="identifier">InternetProtocol</span><span class="special">&gt;()</span></code>.
  154. </p>
  155. </td>
  156. </tr>
  157. <tr>
  158. <td>
  159. <p>
  160. </p>
  161. <pre class="programlisting"><span class="identifier">a</span><span class="special">.</span><span class="identifier">resolve</span><span class="special">(</span><span class="identifier">b</span><span class="special">,</span> <span class="identifier">e</span><span class="special">,</span> <span class="identifier">ec</span><span class="special">);</span>
  162. </pre>
  163. <p>
  164. </p>
  165. </td>
  166. <td>
  167. <p>
  168. </p>
  169. <pre class="programlisting"><span class="identifier">ip</span><span class="special">::</span><span class="identifier">basic_resolver_iterator</span><span class="special">&lt;</span>
  170. <span class="identifier">InternetProtocol</span><span class="special">&gt;</span>
  171. </pre>
  172. <p>
  173. </p>
  174. </td>
  175. <td>
  176. <p>
  177. On success, returns an iterator <code class="computeroutput"><span class="identifier">i</span></code>
  178. such that <code class="computeroutput"><span class="identifier">i</span> <span class="special">!=</span>
  179. <span class="identifier">ip</span><span class="special">::</span><span class="identifier">basic_resolver_iterator</span><span class="special">&lt;</span><span class="identifier">InternetProtocol</span><span class="special">&gt;()</span></code>.
  180. Otherwise returns <code class="computeroutput"><span class="identifier">ip</span><span class="special">::</span><span class="identifier">basic_resolver_iterator</span><span class="special">&lt;</span><span class="identifier">InternetProtocol</span><span class="special">&gt;()</span></code>.
  181. </p>
  182. </td>
  183. </tr>
  184. <tr>
  185. <td>
  186. <p>
  187. </p>
  188. <pre class="programlisting"><span class="identifier">a</span><span class="special">.</span><span class="identifier">async_resolve</span><span class="special">(</span><span class="identifier">b</span><span class="special">,</span> <span class="identifier">e</span><span class="special">,</span> <span class="identifier">h</span><span class="special">);</span>
  189. </pre>
  190. <p>
  191. </p>
  192. </td>
  193. <td>
  194. </td>
  195. <td>
  196. <p>
  197. Initiates an asynchronous resolve operation that is performed via
  198. the <code class="computeroutput"><span class="identifier">io_service</span></code>
  199. object <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">get_io_service</span><span class="special">()</span></code>
  200. and behaves according to <a class="link" href="asynchronous_operations.html" title="Requirements on asynchronous operations">asynchronous
  201. operation</a> requirements.<br> <br> If the operation completes
  202. successfully, the <code class="computeroutput"><span class="identifier">ResolveHandler</span></code>
  203. object <code class="computeroutput"><span class="identifier">h</span></code> shall
  204. be invoked with an iterator object <code class="computeroutput"><span class="identifier">i</span></code>
  205. such that the condition <code class="computeroutput"><span class="identifier">i</span>
  206. <span class="special">!=</span> <span class="identifier">ip</span><span class="special">::</span><span class="identifier">basic_resolver_iterator</span><span class="special">&lt;</span><span class="identifier">InternetProtocol</span><span class="special">&gt;()</span></code> holds. Otherwise it is invoked
  207. with <code class="computeroutput"><span class="identifier">ip</span><span class="special">::</span><span class="identifier">basic_resolver_iterator</span><span class="special">&lt;</span><span class="identifier">InternetProtocol</span><span class="special">&gt;()</span></code>.
  208. </p>
  209. </td>
  210. </tr>
  211. </tbody>
  212. </table></div>
  213. </div>
  214. <br class="table-break">
  215. </div>
  216. <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  217. <td align="left"></td>
  218. <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2014 Christopher M. Kohlhoff<p>
  219. Distributed under the Boost Software License, Version 1.0. (See accompanying
  220. 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>)
  221. </p>
  222. </div></td>
  223. </tr></table>
  224. <hr>
  225. <div class="spirit-nav">
  226. <a accesskey="p" href="ResolveHandler.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="SeqPacketSocketService.html"><img src="../../next.png" alt="Next"></a>
  227. </div>
  228. </body>
  229. </html>