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