ConstBufferSequence.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237
  1. <html>
  2. <head>
  3. <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
  4. <title>Constant buffer sequence 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="ConnectHandler.html" title="Connect handler requirements">
  10. <link rel="next" href="ConvertibleToConstBuffer.html" title="Convertible to const buffer 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="ConnectHandler.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="ConvertibleToConstBuffer.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.ConstBufferSequence"></a><a class="link" href="ConstBufferSequence.html" title="Constant buffer sequence requirements">Constant buffer sequence
  21. requirements</a>
  22. </h3></div></div></div>
  23. <p>
  24. In the table below, <code class="computeroutput"><span class="identifier">X</span></code> denotes
  25. a class containing objects of type <code class="computeroutput"><span class="identifier">T</span></code>,
  26. <code class="computeroutput"><span class="identifier">a</span></code> denotes a value of type
  27. <code class="computeroutput"><span class="identifier">X</span></code> and <code class="computeroutput"><span class="identifier">u</span></code>
  28. denotes an identifier.
  29. </p>
  30. <div class="table">
  31. <a name="asio.reference.ConstBufferSequence.t0"></a><p class="title"><b>Table&#160;5.&#160;ConstBufferSequence requirements</b></p>
  32. <div class="table-contents"><table class="table" summary="ConstBufferSequence requirements">
  33. <colgroup>
  34. <col>
  35. <col>
  36. <col>
  37. </colgroup>
  38. <thead><tr>
  39. <th>
  40. <p>
  41. expression
  42. </p>
  43. </th>
  44. <th>
  45. <p>
  46. return type
  47. </p>
  48. </th>
  49. <th>
  50. <p>
  51. assertion/note<br> pre/post-condition
  52. </p>
  53. </th>
  54. </tr></thead>
  55. <tbody>
  56. <tr>
  57. <td>
  58. <p>
  59. <code class="computeroutput"><span class="identifier">X</span><span class="special">::</span><span class="identifier">value_type</span></code>
  60. </p>
  61. </td>
  62. <td>
  63. <p>
  64. <code class="computeroutput"><span class="identifier">T</span></code>
  65. </p>
  66. </td>
  67. <td>
  68. <p>
  69. <code class="computeroutput"><span class="identifier">T</span></code> meets the requirements
  70. for <a class="link" href="ConvertibleToConstBuffer.html" title="Convertible to const buffer requirements">ConvertibleToConstBuffer</a>.
  71. </p>
  72. </td>
  73. </tr>
  74. <tr>
  75. <td>
  76. <p>
  77. <code class="computeroutput"><span class="identifier">X</span><span class="special">::</span><span class="identifier">const_iterator</span></code>
  78. </p>
  79. </td>
  80. <td>
  81. <p>
  82. iterator type pointing to <code class="computeroutput"><span class="identifier">T</span></code>
  83. </p>
  84. </td>
  85. <td>
  86. <p>
  87. <code class="computeroutput"><span class="identifier">const_iterator</span></code>
  88. meets the requirements for bidirectional iterators (C++ Std, 24.1.4).
  89. </p>
  90. </td>
  91. </tr>
  92. <tr>
  93. <td>
  94. <p>
  95. <code class="computeroutput"><span class="identifier">X</span><span class="special">(</span><span class="identifier">a</span><span class="special">);</span></code>
  96. </p>
  97. </td>
  98. <td>
  99. </td>
  100. <td>
  101. <p>
  102. post: <code class="computeroutput"><span class="identifier">equal_const_buffer_seq</span><span class="special">(</span><span class="identifier">a</span><span class="special">,</span> <span class="identifier">X</span><span class="special">(</span><span class="identifier">a</span><span class="special">))</span></code> where the binary predicate <code class="computeroutput"><span class="identifier">equal_const_buffer_seq</span></code> is defined
  103. as
  104. </p>
  105. <pre class="programlisting"><span class="keyword">bool</span> <span class="identifier">equal_const_buffer_seq</span><span class="special">(</span>
  106. <span class="keyword">const</span> <span class="identifier">X</span><span class="special">&amp;</span> <span class="identifier">x1</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">X</span><span class="special">&amp;</span> <span class="identifier">x2</span><span class="special">)</span>
  107. <span class="special">{</span>
  108. <span class="keyword">return</span>
  109. <span class="identifier">distance</span><span class="special">(</span><span class="identifier">x1</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(),</span> <span class="identifier">x1</span><span class="special">.</span><span class="identifier">end</span><span class="special">())</span>
  110. <span class="special">==</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">x2</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(),</span> <span class="identifier">x2</span><span class="special">.</span><span class="identifier">end</span><span class="special">())</span>
  111. <span class="special">&amp;&amp;</span> <span class="identifier">equal</span><span class="special">(</span><span class="identifier">x1</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(),</span> <span class="identifier">x1</span><span class="special">.</span><span class="identifier">end</span><span class="special">(),</span>
  112. <span class="identifier">x2</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(),</span> <span class="identifier">equal_buffer</span><span class="special">);</span>
  113. <span class="special">}</span>
  114. </pre>
  115. <p>
  116. and the binary predicate <code class="computeroutput"><span class="identifier">equal_buffer</span></code>
  117. is defined as
  118. </p>
  119. <pre class="programlisting"><span class="keyword">bool</span> <span class="identifier">equal_buffer</span><span class="special">(</span>
  120. <span class="keyword">const</span> <span class="identifier">X</span><span class="special">::</span><span class="identifier">value_type</span><span class="special">&amp;</span> <span class="identifier">v1</span><span class="special">,</span>
  121. <span class="keyword">const</span> <span class="identifier">X</span><span class="special">::</span><span class="identifier">value_type</span><span class="special">&amp;</span> <span class="identifier">v2</span><span class="special">)</span>
  122. <span class="special">{</span>
  123. <span class="identifier">const_buffer</span> <span class="identifier">b1</span><span class="special">(</span><span class="identifier">v1</span><span class="special">);</span>
  124. <span class="identifier">const_buffer</span> <span class="identifier">b2</span><span class="special">(</span><span class="identifier">v2</span><span class="special">);</span>
  125. <span class="keyword">return</span>
  126. <span class="identifier">buffer_cast</span><span class="special">&lt;</span><span class="keyword">const</span> <span class="keyword">void</span><span class="special">*&gt;(</span><span class="identifier">b1</span><span class="special">)</span>
  127. <span class="special">==</span> <span class="identifier">buffer_cast</span><span class="special">&lt;</span><span class="keyword">const</span> <span class="keyword">void</span><span class="special">*&gt;(</span><span class="identifier">b2</span><span class="special">)</span>
  128. <span class="special">&amp;&amp;</span> <span class="identifier">buffer_size</span><span class="special">(</span><span class="identifier">b1</span><span class="special">)</span> <span class="special">==</span> <span class="identifier">buffer_size</span><span class="special">(</span><span class="identifier">b2</span><span class="special">);</span>
  129. <span class="special">}</span>
  130. </pre>
  131. <p>
  132. </p>
  133. </td>
  134. </tr>
  135. <tr>
  136. <td>
  137. <p>
  138. <code class="computeroutput"><span class="identifier">X</span> <span class="identifier">u</span><span class="special">(</span><span class="identifier">a</span><span class="special">);</span></code>
  139. </p>
  140. </td>
  141. <td>
  142. </td>
  143. <td>
  144. <p>
  145. post:
  146. </p>
  147. <pre class="programlisting"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">a</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(),</span> <span class="identifier">a</span><span class="special">.</span><span class="identifier">end</span><span class="special">())</span>
  148. <span class="special">==</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">u</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(),</span> <span class="identifier">u</span><span class="special">.</span><span class="identifier">end</span><span class="special">())</span>
  149. <span class="special">&amp;&amp;</span> <span class="identifier">equal</span><span class="special">(</span><span class="identifier">a</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(),</span> <span class="identifier">a</span><span class="special">.</span><span class="identifier">end</span><span class="special">(),</span>
  150. <span class="identifier">u</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(),</span> <span class="identifier">equal_buffer</span><span class="special">)</span>
  151. </pre>
  152. <p>
  153. where the binary predicate <code class="computeroutput"><span class="identifier">equal_buffer</span></code>
  154. is defined as
  155. </p>
  156. <pre class="programlisting"><span class="keyword">bool</span> <span class="identifier">equal_buffer</span><span class="special">(</span>
  157. <span class="keyword">const</span> <span class="identifier">X</span><span class="special">::</span><span class="identifier">value_type</span><span class="special">&amp;</span> <span class="identifier">v1</span><span class="special">,</span>
  158. <span class="keyword">const</span> <span class="identifier">X</span><span class="special">::</span><span class="identifier">value_type</span><span class="special">&amp;</span> <span class="identifier">v2</span><span class="special">)</span>
  159. <span class="special">{</span>
  160. <span class="identifier">const_buffer</span> <span class="identifier">b1</span><span class="special">(</span><span class="identifier">v1</span><span class="special">);</span>
  161. <span class="identifier">const_buffer</span> <span class="identifier">b2</span><span class="special">(</span><span class="identifier">v2</span><span class="special">);</span>
  162. <span class="keyword">return</span>
  163. <span class="identifier">buffer_cast</span><span class="special">&lt;</span><span class="keyword">const</span> <span class="keyword">void</span><span class="special">*&gt;(</span><span class="identifier">b1</span><span class="special">)</span>
  164. <span class="special">==</span> <span class="identifier">buffer_cast</span><span class="special">&lt;</span><span class="keyword">const</span> <span class="keyword">void</span><span class="special">*&gt;(</span><span class="identifier">b2</span><span class="special">)</span>
  165. <span class="special">&amp;&amp;</span> <span class="identifier">buffer_size</span><span class="special">(</span><span class="identifier">b1</span><span class="special">)</span> <span class="special">==</span> <span class="identifier">buffer_size</span><span class="special">(</span><span class="identifier">b2</span><span class="special">);</span>
  166. <span class="special">}</span>
  167. </pre>
  168. <p>
  169. </p>
  170. </td>
  171. </tr>
  172. <tr>
  173. <td>
  174. <p>
  175. <code class="computeroutput"><span class="special">(&amp;</span><span class="identifier">a</span><span class="special">)-&gt;~</span><span class="identifier">X</span><span class="special">();</span></code>
  176. </p>
  177. </td>
  178. <td>
  179. <p>
  180. <code class="computeroutput"><span class="keyword">void</span></code>
  181. </p>
  182. </td>
  183. <td>
  184. <p>
  185. note: the destructor is applied to every element of <code class="computeroutput"><span class="identifier">a</span></code>; all the memory is deallocated.
  186. </p>
  187. </td>
  188. </tr>
  189. <tr>
  190. <td>
  191. <p>
  192. <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">begin</span><span class="special">();</span></code>
  193. </p>
  194. </td>
  195. <td>
  196. <p>
  197. <code class="computeroutput"><span class="identifier">const_iterator</span></code>
  198. or convertible to <code class="computeroutput"><span class="identifier">const_iterator</span></code>
  199. </p>
  200. </td>
  201. <td>
  202. </td>
  203. </tr>
  204. <tr>
  205. <td>
  206. <p>
  207. <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">end</span><span class="special">();</span></code>
  208. </p>
  209. </td>
  210. <td>
  211. <p>
  212. <code class="computeroutput"><span class="identifier">const_iterator</span></code>
  213. or convertible to <code class="computeroutput"><span class="identifier">const_iterator</span></code>
  214. </p>
  215. </td>
  216. <td>
  217. </td>
  218. </tr>
  219. </tbody>
  220. </table></div>
  221. </div>
  222. <br class="table-break">
  223. </div>
  224. <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  225. <td align="left"></td>
  226. <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2014 Christopher M. Kohlhoff<p>
  227. Distributed under the Boost Software License, Version 1.0. (See accompanying
  228. 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>)
  229. </p>
  230. </div></td>
  231. </tr></table>
  232. <hr>
  233. <div class="spirit-nav">
  234. <a accesskey="p" href="ConnectHandler.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="ConvertibleToConstBuffer.html"><img src="../../next.png" alt="Next"></a>
  235. </div>
  236. </body>
  237. </html>