SocketService.html 37 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660
  1. <html>
  2. <head>
  3. <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
  4. <title>Socket 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="SocketAcceptorService.html" title="Socket acceptor service requirements">
  10. <link rel="next" href="StreamDescriptorService.html" title="Stream descriptor 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="SocketAcceptorService.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="StreamDescriptorService.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.SocketService"></a><a class="link" href="SocketService.html" title="Socket service requirements">Socket service requirements</a>
  21. </h3></div></div></div>
  22. <p>
  23. A socket 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> with support for movability, as well as the additional
  25. requirements listed below.
  26. </p>
  27. <p>
  28. In the table below, <code class="computeroutput"><span class="identifier">X</span></code> denotes
  29. a socket service class for protocol <a class="link" href="Protocol.html" title="Protocol requirements"><code class="computeroutput"><span class="identifier">Protocol</span></code></a>, <code class="computeroutput"><span class="identifier">a</span></code>
  30. and <code class="computeroutput"><span class="identifier">ao</span></code> denote values of type
  31. <code class="computeroutput"><span class="identifier">X</span></code>, <code class="computeroutput"><span class="identifier">b</span></code>
  32. and <code class="computeroutput"><span class="identifier">c</span></code> denote values of type
  33. <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">p</span></code>
  34. denotes a value of type <code class="computeroutput"><span class="identifier">Protocol</span></code>,
  35. <code class="computeroutput"><span class="identifier">n</span></code> denotes a value of type
  36. <code class="computeroutput"><span class="identifier">X</span><span class="special">::</span><span class="identifier">native_handle_type</span></code>, <code class="computeroutput"><span class="identifier">e</span></code>
  37. denotes a value of type <code class="computeroutput"><span class="identifier">Protocol</span><span class="special">::</span><span class="identifier">endpoint</span></code>,
  38. <code class="computeroutput"><span class="identifier">ec</span></code> denotes a value of type
  39. <code class="computeroutput"><span class="identifier">error_code</span></code>, <code class="computeroutput"><span class="identifier">s</span></code> denotes a value meeting <a class="link" href="SettableSocketOption.html" title="Settable socket option requirements"><code class="computeroutput"><span class="identifier">SettableSocketOption</span></code></a> requirements,
  40. <code class="computeroutput"><span class="identifier">g</span></code> denotes a value meeting
  41. <a class="link" href="GettableSocketOption.html" title="Gettable socket option requirements"><code class="computeroutput"><span class="identifier">GettableSocketOption</span></code></a>
  42. requirements, <code class="computeroutput"><span class="identifier">i</span></code> denotes a
  43. value meeting <a class="link" href="IoControlCommand.html" title="I/O control command requirements"><code class="computeroutput"><span class="identifier">IoControlCommand</span></code></a> requirements,
  44. <code class="computeroutput"><span class="identifier">h</span></code> denotes a value of type
  45. <code class="computeroutput"><span class="identifier">socket_base</span><span class="special">::</span><span class="identifier">shutdown_type</span></code>, <code class="computeroutput"><span class="identifier">ch</span></code>
  46. denotes a value meeting <a class="link" href="ConnectHandler.html" title="Connect handler requirements"><code class="computeroutput"><span class="identifier">ConnectHandler</span></code></a> requirements, and
  47. <code class="computeroutput"><span class="identifier">u</span></code> and <code class="computeroutput"><span class="identifier">v</span></code>
  48. denote identifiers.
  49. </p>
  50. <div class="table">
  51. <a name="asio.reference.SocketService.t0"></a><p class="title"><b>Table&#160;30.&#160;SocketService requirements</b></p>
  52. <div class="table-contents"><table class="table" summary="SocketService requirements">
  53. <colgroup>
  54. <col>
  55. <col>
  56. <col>
  57. </colgroup>
  58. <thead><tr>
  59. <th>
  60. <p>
  61. expression
  62. </p>
  63. </th>
  64. <th>
  65. <p>
  66. return type
  67. </p>
  68. </th>
  69. <th>
  70. <p>
  71. assertion/note<br> pre/post-condition
  72. </p>
  73. </th>
  74. </tr></thead>
  75. <tbody>
  76. <tr>
  77. <td>
  78. <p>
  79. <code class="computeroutput"><span class="identifier">X</span><span class="special">::</span><span class="identifier">native_handle_type</span></code>
  80. </p>
  81. </td>
  82. <td>
  83. </td>
  84. <td>
  85. <p>
  86. The implementation-defined native representation of a socket. Must
  87. satisfy the requirements of <code class="computeroutput"><span class="identifier">CopyConstructible</span></code>
  88. types (C++ Std, 20.1.3), and the requirements of <code class="computeroutput"><span class="identifier">Assignable</span></code> types (C++ Std, 23.1).
  89. </p>
  90. </td>
  91. </tr>
  92. <tr>
  93. <td>
  94. <p>
  95. <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">construct</span><span class="special">(</span><span class="identifier">b</span><span class="special">);</span></code>
  96. </p>
  97. </td>
  98. <td>
  99. </td>
  100. <td>
  101. <p>
  102. From <a class="link" href="IoObjectService.html" title="I/O object service requirements">IoObjectService</a>
  103. requirements.<br> post: <code class="computeroutput"><span class="special">!</span><span class="identifier">a</span><span class="special">.</span><span class="identifier">is_open</span><span class="special">(</span><span class="identifier">b</span><span class="special">)</span></code>.
  104. </p>
  105. </td>
  106. </tr>
  107. <tr>
  108. <td>
  109. <p>
  110. <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>
  111. </p>
  112. </td>
  113. <td>
  114. </td>
  115. <td>
  116. <p>
  117. From <a class="link" href="IoObjectService.html" title="I/O object service requirements">IoObjectService</a>
  118. requirements. Implicitly cancels asynchronous operations, as if
  119. by calling <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">close</span><span class="special">(</span><span class="identifier">b</span><span class="special">,</span>
  120. <span class="identifier">ec</span><span class="special">)</span></code>.
  121. </p>
  122. </td>
  123. </tr>
  124. <tr>
  125. <td>
  126. <p>
  127. </p>
  128. <pre class="programlisting"><span class="identifier">a</span><span class="special">.</span><span class="identifier">move_construct</span><span class="special">(</span><span class="identifier">b</span><span class="special">,</span> <span class="identifier">c</span><span class="special">);</span>
  129. </pre>
  130. <p>
  131. </p>
  132. </td>
  133. <td>
  134. </td>
  135. <td>
  136. <p>
  137. From <a class="link" href="IoObjectService.html" title="I/O object service requirements">IoObjectService</a>
  138. requirements. The underlying native representation is moved from
  139. <code class="computeroutput"><span class="identifier">c</span></code> to <code class="computeroutput"><span class="identifier">b</span></code>.
  140. </p>
  141. </td>
  142. </tr>
  143. <tr>
  144. <td>
  145. <p>
  146. </p>
  147. <pre class="programlisting"><span class="identifier">a</span><span class="special">.</span><span class="identifier">move_assign</span><span class="special">(</span><span class="identifier">b</span><span class="special">,</span> <span class="identifier">ao</span><span class="special">,</span> <span class="identifier">c</span><span class="special">);</span>
  148. </pre>
  149. <p>
  150. </p>
  151. </td>
  152. <td>
  153. </td>
  154. <td>
  155. <p>
  156. From <a class="link" href="IoObjectService.html" title="I/O object service requirements">IoObjectService</a>
  157. requirements. Implicitly cancels asynchronous operations associated
  158. with <code class="computeroutput"><span class="identifier">b</span></code>, as if by
  159. calling <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">close</span><span class="special">(</span><span class="identifier">b</span><span class="special">,</span>
  160. <span class="identifier">ec</span><span class="special">)</span></code>.
  161. Then the underlying native representation is moved from <code class="computeroutput"><span class="identifier">c</span></code> to <code class="computeroutput"><span class="identifier">b</span></code>.
  162. </p>
  163. </td>
  164. </tr>
  165. <tr>
  166. <td>
  167. <p>
  168. </p>
  169. <pre class="programlisting"><span class="identifier">a</span><span class="special">.</span><span class="identifier">open</span><span class="special">(</span><span class="identifier">b</span><span class="special">,</span> <span class="identifier">p</span><span class="special">,</span> <span class="identifier">ec</span><span class="special">);</span>
  170. </pre>
  171. <p>
  172. </p>
  173. </td>
  174. <td>
  175. <p>
  176. <code class="computeroutput"><span class="identifier">error_code</span></code>
  177. </p>
  178. </td>
  179. <td>
  180. <p>
  181. pre: <code class="computeroutput"><span class="special">!</span><span class="identifier">a</span><span class="special">.</span><span class="identifier">is_open</span><span class="special">(</span><span class="identifier">b</span><span class="special">)</span></code>.<br> post: <code class="computeroutput"><span class="special">!!</span><span class="identifier">ec</span> <span class="special">||</span>
  182. <span class="identifier">a</span><span class="special">.</span><span class="identifier">is_open</span><span class="special">(</span><span class="identifier">b</span><span class="special">)</span></code>.
  183. </p>
  184. </td>
  185. </tr>
  186. <tr>
  187. <td>
  188. <p>
  189. </p>
  190. <pre class="programlisting"><span class="identifier">a</span><span class="special">.</span><span class="identifier">assign</span><span class="special">(</span><span class="identifier">b</span><span class="special">,</span> <span class="identifier">p</span><span class="special">,</span> <span class="identifier">n</span><span class="special">,</span> <span class="identifier">ec</span><span class="special">);</span>
  191. </pre>
  192. <p>
  193. </p>
  194. </td>
  195. <td>
  196. <p>
  197. <code class="computeroutput"><span class="identifier">error_code</span></code>
  198. </p>
  199. </td>
  200. <td>
  201. <p>
  202. pre: <code class="computeroutput"><span class="special">!</span><span class="identifier">a</span><span class="special">.</span><span class="identifier">is_open</span><span class="special">(</span><span class="identifier">b</span><span class="special">)</span></code>.<br> post: <code class="computeroutput"><span class="special">!!</span><span class="identifier">ec</span> <span class="special">||</span>
  203. <span class="identifier">a</span><span class="special">.</span><span class="identifier">is_open</span><span class="special">(</span><span class="identifier">b</span><span class="special">)</span></code>.
  204. </p>
  205. </td>
  206. </tr>
  207. <tr>
  208. <td>
  209. <p>
  210. </p>
  211. <pre class="programlisting"><span class="identifier">a</span><span class="special">.</span><span class="identifier">is_open</span><span class="special">(</span><span class="identifier">b</span><span class="special">);</span>
  212. </pre>
  213. <p>
  214. </p>
  215. </td>
  216. <td>
  217. <p>
  218. <code class="computeroutput"><span class="keyword">bool</span></code>
  219. </p>
  220. </td>
  221. <td>
  222. </td>
  223. </tr>
  224. <tr>
  225. <td>
  226. <p>
  227. </p>
  228. <pre class="programlisting"><span class="keyword">const</span> <span class="identifier">X</span><span class="special">&amp;</span> <span class="identifier">u</span> <span class="special">=</span> <span class="identifier">a</span><span class="special">;</span>
  229. <span class="keyword">const</span> <span class="identifier">X</span><span class="special">::</span><span class="identifier">implementation_type</span><span class="special">&amp;</span> <span class="identifier">v</span> <span class="special">=</span> <span class="identifier">b</span><span class="special">;</span>
  230. <span class="identifier">u</span><span class="special">.</span><span class="identifier">is_open</span><span class="special">(</span><span class="identifier">v</span><span class="special">);</span>
  231. </pre>
  232. <p>
  233. </p>
  234. </td>
  235. <td>
  236. <p>
  237. <code class="computeroutput"><span class="keyword">bool</span></code>
  238. </p>
  239. </td>
  240. <td>
  241. </td>
  242. </tr>
  243. <tr>
  244. <td>
  245. <p>
  246. </p>
  247. <pre class="programlisting"><span class="identifier">a</span><span class="special">.</span><span class="identifier">close</span><span class="special">(</span><span class="identifier">b</span><span class="special">,</span> <span class="identifier">ec</span><span class="special">);</span>
  248. </pre>
  249. <p>
  250. </p>
  251. </td>
  252. <td>
  253. <p>
  254. <code class="computeroutput"><span class="identifier">error_code</span></code>
  255. </p>
  256. </td>
  257. <td>
  258. <p>
  259. If <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">is_open</span><span class="special">()</span></code>
  260. is true, causes any outstanding asynchronous operations to complete
  261. as soon as possible. Handlers for cancelled operations shall be
  262. passed the error code <code class="computeroutput"><span class="identifier">error</span><span class="special">::</span><span class="identifier">operation_aborted</span></code>.<br>
  263. post: <code class="computeroutput"><span class="special">!</span><span class="identifier">a</span><span class="special">.</span><span class="identifier">is_open</span><span class="special">(</span><span class="identifier">b</span><span class="special">)</span></code>.
  264. </p>
  265. </td>
  266. </tr>
  267. <tr>
  268. <td>
  269. <p>
  270. </p>
  271. <pre class="programlisting"><span class="identifier">a</span><span class="special">.</span><span class="identifier">native_handle</span><span class="special">(</span><span class="identifier">b</span><span class="special">);</span>
  272. </pre>
  273. <p>
  274. </p>
  275. </td>
  276. <td>
  277. <p>
  278. <code class="computeroutput"><span class="identifier">X</span><span class="special">::</span><span class="identifier">native_handle_type</span></code>
  279. </p>
  280. </td>
  281. <td>
  282. </td>
  283. </tr>
  284. <tr>
  285. <td>
  286. <p>
  287. </p>
  288. <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>
  289. </pre>
  290. <p>
  291. </p>
  292. </td>
  293. <td>
  294. <p>
  295. <code class="computeroutput"><span class="identifier">error_code</span></code>
  296. </p>
  297. </td>
  298. <td>
  299. <p>
  300. pre: <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">is_open</span><span class="special">(</span><span class="identifier">b</span><span class="special">)</span></code>.<br>
  301. Causes any outstanding asynchronous operations to complete as soon
  302. as possible. Handlers for cancelled operations shall be passed
  303. the error code <code class="computeroutput"><span class="identifier">error</span><span class="special">::</span><span class="identifier">operation_aborted</span></code>.
  304. </p>
  305. </td>
  306. </tr>
  307. <tr>
  308. <td>
  309. <p>
  310. </p>
  311. <pre class="programlisting"><span class="identifier">a</span><span class="special">.</span><span class="identifier">set_option</span><span class="special">(</span><span class="identifier">b</span><span class="special">,</span> <span class="identifier">s</span><span class="special">,</span> <span class="identifier">ec</span><span class="special">);</span>
  312. </pre>
  313. <p>
  314. </p>
  315. </td>
  316. <td>
  317. <p>
  318. <code class="computeroutput"><span class="identifier">error_code</span></code>
  319. </p>
  320. </td>
  321. <td>
  322. <p>
  323. pre: <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">is_open</span><span class="special">(</span><span class="identifier">b</span><span class="special">)</span></code>.
  324. </p>
  325. </td>
  326. </tr>
  327. <tr>
  328. <td>
  329. <p>
  330. </p>
  331. <pre class="programlisting"><span class="identifier">a</span><span class="special">.</span><span class="identifier">get_option</span><span class="special">(</span><span class="identifier">b</span><span class="special">,</span> <span class="identifier">g</span><span class="special">,</span> <span class="identifier">ec</span><span class="special">);</span>
  332. </pre>
  333. <p>
  334. </p>
  335. </td>
  336. <td>
  337. <p>
  338. <code class="computeroutput"><span class="identifier">error_code</span></code>
  339. </p>
  340. </td>
  341. <td>
  342. <p>
  343. pre: <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">is_open</span><span class="special">(</span><span class="identifier">b</span><span class="special">)</span></code>.
  344. </p>
  345. </td>
  346. </tr>
  347. <tr>
  348. <td>
  349. <p>
  350. </p>
  351. <pre class="programlisting"><span class="keyword">const</span> <span class="identifier">X</span><span class="special">&amp;</span> <span class="identifier">u</span> <span class="special">=</span> <span class="identifier">a</span><span class="special">;</span>
  352. <span class="keyword">const</span> <span class="identifier">X</span><span class="special">::</span><span class="identifier">implementation_type</span><span class="special">&amp;</span> <span class="identifier">v</span> <span class="special">=</span> <span class="identifier">b</span><span class="special">;</span>
  353. <span class="identifier">u</span><span class="special">.</span><span class="identifier">get_option</span><span class="special">(</span><span class="identifier">v</span><span class="special">,</span> <span class="identifier">g</span><span class="special">,</span> <span class="identifier">ec</span><span class="special">);</span>
  354. </pre>
  355. <p>
  356. </p>
  357. </td>
  358. <td>
  359. <p>
  360. <code class="computeroutput"><span class="identifier">error_code</span></code>
  361. </p>
  362. </td>
  363. <td>
  364. <p>
  365. pre: <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">is_open</span><span class="special">(</span><span class="identifier">b</span><span class="special">)</span></code>.
  366. </p>
  367. </td>
  368. </tr>
  369. <tr>
  370. <td>
  371. <p>
  372. </p>
  373. <pre class="programlisting"><span class="identifier">a</span><span class="special">.</span><span class="identifier">io_control</span><span class="special">(</span><span class="identifier">b</span><span class="special">,</span> <span class="identifier">i</span><span class="special">,</span> <span class="identifier">ec</span><span class="special">);</span>
  374. </pre>
  375. <p>
  376. </p>
  377. </td>
  378. <td>
  379. <p>
  380. <code class="computeroutput"><span class="identifier">error_code</span></code>
  381. </p>
  382. </td>
  383. <td>
  384. <p>
  385. pre: <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">is_open</span><span class="special">(</span><span class="identifier">b</span><span class="special">)</span></code>.
  386. </p>
  387. </td>
  388. </tr>
  389. <tr>
  390. <td>
  391. <p>
  392. </p>
  393. <pre class="programlisting"><span class="identifier">a</span><span class="special">.</span><span class="identifier">at_mark</span><span class="special">(</span><span class="identifier">b</span><span class="special">,</span> <span class="identifier">ec</span><span class="special">);</span>
  394. </pre>
  395. <p>
  396. </p>
  397. </td>
  398. <td>
  399. <p>
  400. <code class="computeroutput"><span class="keyword">bool</span></code>
  401. </p>
  402. </td>
  403. <td>
  404. <p>
  405. pre: <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">is_open</span><span class="special">(</span><span class="identifier">b</span><span class="special">)</span></code>.
  406. </p>
  407. </td>
  408. </tr>
  409. <tr>
  410. <td>
  411. <p>
  412. </p>
  413. <pre class="programlisting"><span class="keyword">const</span> <span class="identifier">X</span><span class="special">&amp;</span> <span class="identifier">u</span> <span class="special">=</span> <span class="identifier">a</span><span class="special">;</span>
  414. <span class="keyword">const</span> <span class="identifier">X</span><span class="special">::</span><span class="identifier">implementation_type</span><span class="special">&amp;</span> <span class="identifier">v</span> <span class="special">=</span> <span class="identifier">b</span><span class="special">;</span>
  415. <span class="identifier">u</span><span class="special">.</span><span class="identifier">at_mark</span><span class="special">(</span><span class="identifier">v</span><span class="special">,</span> <span class="identifier">ec</span><span class="special">);</span>
  416. </pre>
  417. <p>
  418. </p>
  419. </td>
  420. <td>
  421. <p>
  422. <code class="computeroutput"><span class="keyword">bool</span></code>
  423. </p>
  424. </td>
  425. <td>
  426. <p>
  427. pre: <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">is_open</span><span class="special">(</span><span class="identifier">b</span><span class="special">)</span></code>.
  428. </p>
  429. </td>
  430. </tr>
  431. <tr>
  432. <td>
  433. <p>
  434. </p>
  435. <pre class="programlisting"><span class="identifier">a</span><span class="special">.</span><span class="identifier">available</span><span class="special">(</span><span class="identifier">b</span><span class="special">,</span> <span class="identifier">ec</span><span class="special">);</span>
  436. </pre>
  437. <p>
  438. </p>
  439. </td>
  440. <td>
  441. <p>
  442. <code class="computeroutput"><span class="identifier">size_t</span></code>
  443. </p>
  444. </td>
  445. <td>
  446. <p>
  447. pre: <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">is_open</span><span class="special">(</span><span class="identifier">b</span><span class="special">)</span></code>.
  448. </p>
  449. </td>
  450. </tr>
  451. <tr>
  452. <td>
  453. <p>
  454. </p>
  455. <pre class="programlisting"><span class="keyword">const</span> <span class="identifier">X</span><span class="special">&amp;</span> <span class="identifier">u</span> <span class="special">=</span> <span class="identifier">a</span><span class="special">;</span>
  456. <span class="keyword">const</span> <span class="identifier">X</span><span class="special">::</span><span class="identifier">implementation_type</span><span class="special">&amp;</span> <span class="identifier">v</span> <span class="special">=</span> <span class="identifier">b</span><span class="special">;</span>
  457. <span class="identifier">u</span><span class="special">.</span><span class="identifier">available</span><span class="special">(</span><span class="identifier">v</span><span class="special">,</span> <span class="identifier">ec</span><span class="special">);</span>
  458. </pre>
  459. <p>
  460. </p>
  461. </td>
  462. <td>
  463. <p>
  464. <code class="computeroutput"><span class="identifier">size_t</span></code>
  465. </p>
  466. </td>
  467. <td>
  468. <p>
  469. pre: <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">is_open</span><span class="special">(</span><span class="identifier">b</span><span class="special">)</span></code>.
  470. </p>
  471. </td>
  472. </tr>
  473. <tr>
  474. <td>
  475. <p>
  476. </p>
  477. <pre class="programlisting"><span class="keyword">const</span> <span class="keyword">typename</span> <span class="identifier">Protocol</span><span class="special">::</span><span class="identifier">endpoint</span><span class="special">&amp;</span> <span class="identifier">u</span> <span class="special">=</span> <span class="identifier">e</span><span class="special">;</span>
  478. <span class="identifier">a</span><span class="special">.</span><span class="identifier">bind</span><span class="special">(</span><span class="identifier">b</span><span class="special">,</span> <span class="identifier">u</span><span class="special">,</span> <span class="identifier">ec</span><span class="special">);</span>
  479. </pre>
  480. <p>
  481. </p>
  482. </td>
  483. <td>
  484. <p>
  485. <code class="computeroutput"><span class="identifier">error_code</span></code>
  486. </p>
  487. </td>
  488. <td>
  489. <p>
  490. pre: <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">is_open</span><span class="special">(</span><span class="identifier">b</span><span class="special">)</span></code>.
  491. </p>
  492. </td>
  493. </tr>
  494. <tr>
  495. <td>
  496. <p>
  497. </p>
  498. <pre class="programlisting"><span class="identifier">a</span><span class="special">.</span><span class="identifier">shutdown</span><span class="special">(</span><span class="identifier">b</span><span class="special">,</span> <span class="identifier">h</span><span class="special">,</span> <span class="identifier">ec</span><span class="special">);</span>
  499. </pre>
  500. <p>
  501. </p>
  502. </td>
  503. <td>
  504. <p>
  505. <code class="computeroutput"><span class="identifier">error_code</span></code>
  506. </p>
  507. </td>
  508. <td>
  509. <p>
  510. pre: <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">is_open</span><span class="special">(</span><span class="identifier">b</span><span class="special">)</span></code>.
  511. </p>
  512. </td>
  513. </tr>
  514. <tr>
  515. <td>
  516. <p>
  517. </p>
  518. <pre class="programlisting"><span class="identifier">a</span><span class="special">.</span><span class="identifier">local_endpoint</span><span class="special">(</span><span class="identifier">b</span><span class="special">,</span> <span class="identifier">ec</span><span class="special">);</span>
  519. </pre>
  520. <p>
  521. </p>
  522. </td>
  523. <td>
  524. <p>
  525. <code class="computeroutput"><span class="identifier">Protocol</span><span class="special">::</span><span class="identifier">endpoint</span></code>
  526. </p>
  527. </td>
  528. <td>
  529. <p>
  530. pre: <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">is_open</span><span class="special">(</span><span class="identifier">b</span><span class="special">)</span></code>.
  531. </p>
  532. </td>
  533. </tr>
  534. <tr>
  535. <td>
  536. <p>
  537. </p>
  538. <pre class="programlisting"><span class="keyword">const</span> <span class="identifier">X</span><span class="special">&amp;</span> <span class="identifier">u</span> <span class="special">=</span> <span class="identifier">a</span><span class="special">;</span>
  539. <span class="keyword">const</span> <span class="identifier">X</span><span class="special">::</span><span class="identifier">implementation_type</span><span class="special">&amp;</span> <span class="identifier">v</span> <span class="special">=</span> <span class="identifier">b</span><span class="special">;</span>
  540. <span class="identifier">u</span><span class="special">.</span><span class="identifier">local_endpoint</span><span class="special">(</span><span class="identifier">v</span><span class="special">,</span> <span class="identifier">ec</span><span class="special">);</span>
  541. </pre>
  542. <p>
  543. </p>
  544. </td>
  545. <td>
  546. <p>
  547. <code class="computeroutput"><span class="identifier">Protocol</span><span class="special">::</span><span class="identifier">endpoint</span></code>
  548. </p>
  549. </td>
  550. <td>
  551. <p>
  552. pre: <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">is_open</span><span class="special">(</span><span class="identifier">b</span><span class="special">)</span></code>.
  553. </p>
  554. </td>
  555. </tr>
  556. <tr>
  557. <td>
  558. <p>
  559. </p>
  560. <pre class="programlisting"><span class="identifier">a</span><span class="special">.</span><span class="identifier">remote_endpoint</span><span class="special">(</span><span class="identifier">b</span><span class="special">,</span> <span class="identifier">ec</span><span class="special">);</span>
  561. </pre>
  562. <p>
  563. </p>
  564. </td>
  565. <td>
  566. <p>
  567. <code class="computeroutput"><span class="identifier">Protocol</span><span class="special">::</span><span class="identifier">endpoint</span></code>
  568. </p>
  569. </td>
  570. <td>
  571. <p>
  572. pre: <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">is_open</span><span class="special">(</span><span class="identifier">b</span><span class="special">)</span></code>.
  573. </p>
  574. </td>
  575. </tr>
  576. <tr>
  577. <td>
  578. <p>
  579. </p>
  580. <pre class="programlisting"><span class="keyword">const</span> <span class="identifier">X</span><span class="special">&amp;</span> <span class="identifier">u</span> <span class="special">=</span> <span class="identifier">a</span><span class="special">;</span>
  581. <span class="keyword">const</span> <span class="identifier">X</span><span class="special">::</span><span class="identifier">implementation_type</span><span class="special">&amp;</span> <span class="identifier">v</span> <span class="special">=</span> <span class="identifier">b</span><span class="special">;</span>
  582. <span class="identifier">u</span><span class="special">.</span><span class="identifier">remote_endpoint</span><span class="special">(</span><span class="identifier">v</span><span class="special">,</span> <span class="identifier">ec</span><span class="special">);</span>
  583. </pre>
  584. <p>
  585. </p>
  586. </td>
  587. <td>
  588. <p>
  589. <code class="computeroutput"><span class="identifier">Protocol</span><span class="special">::</span><span class="identifier">endpoint</span></code>
  590. </p>
  591. </td>
  592. <td>
  593. <p>
  594. pre: <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">is_open</span><span class="special">(</span><span class="identifier">b</span><span class="special">)</span></code>.
  595. </p>
  596. </td>
  597. </tr>
  598. <tr>
  599. <td>
  600. <p>
  601. </p>
  602. <pre class="programlisting"><span class="keyword">const</span> <span class="keyword">typename</span> <span class="identifier">Protocol</span><span class="special">::</span><span class="identifier">endpoint</span><span class="special">&amp;</span> <span class="identifier">u</span> <span class="special">=</span> <span class="identifier">e</span><span class="special">;</span>
  603. <span class="identifier">a</span><span class="special">.</span><span class="identifier">connect</span><span class="special">(</span><span class="identifier">b</span><span class="special">,</span> <span class="identifier">u</span><span class="special">,</span> <span class="identifier">ec</span><span class="special">);</span>
  604. </pre>
  605. <p>
  606. </p>
  607. </td>
  608. <td>
  609. <p>
  610. <code class="computeroutput"><span class="identifier">error_code</span></code>
  611. </p>
  612. </td>
  613. <td>
  614. <p>
  615. pre: <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">is_open</span><span class="special">(</span><span class="identifier">b</span><span class="special">)</span></code>.
  616. </p>
  617. </td>
  618. </tr>
  619. <tr>
  620. <td>
  621. <p>
  622. </p>
  623. <pre class="programlisting"><span class="keyword">const</span> <span class="keyword">typename</span> <span class="identifier">Protocol</span><span class="special">::</span><span class="identifier">endpoint</span><span class="special">&amp;</span> <span class="identifier">u</span> <span class="special">=</span> <span class="identifier">e</span><span class="special">;</span>
  624. <span class="identifier">a</span><span class="special">.</span><span class="identifier">async_connect</span><span class="special">(</span><span class="identifier">b</span><span class="special">,</span> <span class="identifier">u</span><span class="special">,</span> <span class="identifier">ch</span><span class="special">);</span>
  625. </pre>
  626. <p>
  627. </p>
  628. </td>
  629. <td>
  630. </td>
  631. <td>
  632. <p>
  633. pre: <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">is_open</span><span class="special">(</span><span class="identifier">b</span><span class="special">)</span></code>.<br>
  634. Initiates an asynchronous connect operation that is performed via
  635. the <code class="computeroutput"><span class="identifier">io_service</span></code>
  636. 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>
  637. and behaves according to <a class="link" href="asynchronous_operations.html" title="Requirements on asynchronous operations">asynchronous
  638. operation</a> requirements.
  639. </p>
  640. </td>
  641. </tr>
  642. </tbody>
  643. </table></div>
  644. </div>
  645. <br class="table-break">
  646. </div>
  647. <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  648. <td align="left"></td>
  649. <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2014 Christopher M. Kohlhoff<p>
  650. Distributed under the Boost Software License, Version 1.0. (See accompanying
  651. 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>)
  652. </p>
  653. </div></td>
  654. </tr></table>
  655. <hr>
  656. <div class="spirit-nav">
  657. <a accesskey="p" href="SocketAcceptorService.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="StreamDescriptorService.html"><img src="../../next.png" alt="Next"></a>
  658. </div>
  659. </body>
  660. </html>