classgrpc_1_1_byte_buffer.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.6"/>
  7. <title>GRPC C++: grpc::ByteBuffer Class Reference</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  12. <script type="text/javascript" src="search/search.js"></script>
  13. <script type="text/javascript">
  14. $(document).ready(function() { searchBox.OnSelectItem(0); });
  15. </script>
  16. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  17. </head>
  18. <body>
  19. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  20. <div id="titlearea">
  21. <table cellspacing="0" cellpadding="0">
  22. <tbody>
  23. <tr style="height: 56px;">
  24. <td style="padding-left: 0.5em;">
  25. <div id="projectname">GRPC C++
  26. &#160;<span id="projectnumber">0.11.0.0</span>
  27. </div>
  28. </td>
  29. </tr>
  30. </tbody>
  31. </table>
  32. </div>
  33. <!-- end header part -->
  34. <!-- Generated by Doxygen 1.8.6 -->
  35. <script type="text/javascript">
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. </script>
  38. <div id="navrow1" class="tabs">
  39. <ul class="tablist">
  40. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  41. <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  42. <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  43. <li><a href="files.html"><span>Files</span></a></li>
  44. <li>
  45. <div id="MSearchBox" class="MSearchBoxInactive">
  46. <span class="left">
  47. <img id="MSearchSelect" src="search/mag_sel.png"
  48. onmouseover="return searchBox.OnSearchSelectShow()"
  49. onmouseout="return searchBox.OnSearchSelectHide()"
  50. alt=""/>
  51. <input type="text" id="MSearchField" value="Search" accesskey="S"
  52. onfocus="searchBox.OnSearchFieldFocus(true)"
  53. onblur="searchBox.OnSearchFieldFocus(false)"
  54. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  55. </span><span class="right">
  56. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  57. </span>
  58. </div>
  59. </li>
  60. </ul>
  61. </div>
  62. <div id="navrow2" class="tabs2">
  63. <ul class="tablist">
  64. <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  65. <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
  66. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  67. <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
  68. </ul>
  69. </div>
  70. <!-- window showing the filter options -->
  71. <div id="MSearchSelectWindow"
  72. onmouseover="return searchBox.OnSearchSelectShow()"
  73. onmouseout="return searchBox.OnSearchSelectHide()"
  74. onkeydown="return searchBox.OnSearchSelectKey(event)">
  75. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark">&#160;</span>Pages</a></div>
  76. <!-- iframe showing the search results (closed by default) -->
  77. <div id="MSearchResultsWindow">
  78. <iframe src="javascript:void(0)" frameborder="0"
  79. name="MSearchResults" id="MSearchResults">
  80. </iframe>
  81. </div>
  82. <div id="nav-path" class="navpath">
  83. <ul>
  84. <li class="navelem"><a class="el" href="namespacegrpc.html">grpc</a></li><li class="navelem"><a class="el" href="classgrpc_1_1_byte_buffer.html">ByteBuffer</a></li> </ul>
  85. </div>
  86. </div><!-- top -->
  87. <div class="header">
  88. <div class="summary">
  89. <a href="#pub-methods">Public Member Functions</a> &#124;
  90. <a href="#friends">Friends</a> </div>
  91. <div class="headertitle">
  92. <div class="title">grpc::ByteBuffer Class Reference</div> </div>
  93. </div><!--header-->
  94. <div class="contents">
  95. <p>A sequence of bytes.
  96. <a href="classgrpc_1_1_byte_buffer.html#details">More...</a></p>
  97. <p><code>#include &lt;<a class="el" href="byte__buffer_8h_source.html">byte_buffer.h</a>&gt;</code></p>
  98. <table class="memberdecls">
  99. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  100. Public Member Functions</h2></td></tr>
  101. <tr class="memitem:aa3037355cbd37dce99c97e5c3700a76b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_byte_buffer.html#aa3037355cbd37dce99c97e5c3700a76b">ByteBuffer</a> ()</td></tr>
  102. <tr class="memdesc:aa3037355cbd37dce99c97e5c3700a76b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constuct an empty buffer. <a href="#aa3037355cbd37dce99c97e5c3700a76b">More...</a><br/></td></tr>
  103. <tr class="separator:aa3037355cbd37dce99c97e5c3700a76b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:aa1f69f81c3cb03c61b544a0222e83004"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_byte_buffer.html#aa1f69f81c3cb03c61b544a0222e83004">ByteBuffer</a> (const <a class="el" href="classgrpc_1_1_slice.html">Slice</a> *slices, size_t nslices)</td></tr>
  105. <tr class="memdesc:aa1f69f81c3cb03c61b544a0222e83004"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct buffer from <em>slices</em>, of which there are <em>nslices</em>. <a href="#aa1f69f81c3cb03c61b544a0222e83004">More...</a><br/></td></tr>
  106. <tr class="separator:aa1f69f81c3cb03c61b544a0222e83004"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:aeb5dd0045ed262de06481465326bd64a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_byte_buffer.html#aeb5dd0045ed262de06481465326bd64a">~ByteBuffer</a> ()</td></tr>
  108. <tr class="separator:aeb5dd0045ed262de06481465326bd64a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:a1b284d25c0c3c594c386800c548048f1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_byte_buffer.html#a1b284d25c0c3c594c386800c548048f1">Dump</a> (std::vector&lt; <a class="el" href="classgrpc_1_1_slice.html">Slice</a> &gt; *slices) const </td></tr>
  110. <tr class="memdesc:a1b284d25c0c3c594c386800c548048f1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dump (read) the buffer contents into <em>slices</em>. <a href="#a1b284d25c0c3c594c386800c548048f1">More...</a><br/></td></tr>
  111. <tr class="separator:a1b284d25c0c3c594c386800c548048f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <tr class="memitem:a185b593e5c7d2b888fa377989a6bae80"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_byte_buffer.html#a185b593e5c7d2b888fa377989a6bae80">Clear</a> ()</td></tr>
  113. <tr class="memdesc:a185b593e5c7d2b888fa377989a6bae80"><td class="mdescLeft">&#160;</td><td class="mdescRight">Remove all data. <a href="#a185b593e5c7d2b888fa377989a6bae80">More...</a><br/></td></tr>
  114. <tr class="separator:a185b593e5c7d2b888fa377989a6bae80"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <tr class="memitem:a9429e928982f8d94ff93a1a91032ad59"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_byte_buffer.html#a9429e928982f8d94ff93a1a91032ad59">Length</a> () const </td></tr>
  116. <tr class="memdesc:a9429e928982f8d94ff93a1a91032ad59"><td class="mdescLeft">&#160;</td><td class="mdescRight">Buffer size in bytes. <a href="#a9429e928982f8d94ff93a1a91032ad59">More...</a><br/></td></tr>
  117. <tr class="separator:a9429e928982f8d94ff93a1a91032ad59"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. </table><table class="memberdecls">
  119. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
  120. Friends</h2></td></tr>
  121. <tr class="memitem:ab90fe50537dd6fe009b7b913652420f0"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_byte_buffer.html#ab90fe50537dd6fe009b7b913652420f0">SerializationTraits&lt; ByteBuffer, void &gt;</a></td></tr>
  122. <tr class="separator:ab90fe50537dd6fe009b7b913652420f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. </table>
  124. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  125. <div class="textblock"><p>A sequence of bytes. </p>
  126. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  127. <a class="anchor" id="aa3037355cbd37dce99c97e5c3700a76b"></a>
  128. <div class="memitem">
  129. <div class="memproto">
  130. <table class="mlabels">
  131. <tr>
  132. <td class="mlabels-left">
  133. <table class="memname">
  134. <tr>
  135. <td class="memname">grpc::ByteBuffer::ByteBuffer </td>
  136. <td>(</td>
  137. <td class="paramname"></td><td>)</td>
  138. <td></td>
  139. </tr>
  140. </table>
  141. </td>
  142. <td class="mlabels-right">
  143. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  144. </tr>
  145. </table>
  146. </div><div class="memdoc">
  147. <p>Constuct an empty buffer. </p>
  148. </div>
  149. </div>
  150. <a class="anchor" id="aa1f69f81c3cb03c61b544a0222e83004"></a>
  151. <div class="memitem">
  152. <div class="memproto">
  153. <table class="memname">
  154. <tr>
  155. <td class="memname">grpc::ByteBuffer::ByteBuffer </td>
  156. <td>(</td>
  157. <td class="paramtype">const <a class="el" href="classgrpc_1_1_slice.html">Slice</a> *&#160;</td>
  158. <td class="paramname"><em>slices</em>, </td>
  159. </tr>
  160. <tr>
  161. <td class="paramkey"></td>
  162. <td></td>
  163. <td class="paramtype">size_t&#160;</td>
  164. <td class="paramname"><em>nslices</em>&#160;</td>
  165. </tr>
  166. <tr>
  167. <td></td>
  168. <td>)</td>
  169. <td></td><td></td>
  170. </tr>
  171. </table>
  172. </div><div class="memdoc">
  173. <p>Construct buffer from <em>slices</em>, of which there are <em>nslices</em>. </p>
  174. </div>
  175. </div>
  176. <a class="anchor" id="aeb5dd0045ed262de06481465326bd64a"></a>
  177. <div class="memitem">
  178. <div class="memproto">
  179. <table class="memname">
  180. <tr>
  181. <td class="memname">grpc::ByteBuffer::~ByteBuffer </td>
  182. <td>(</td>
  183. <td class="paramname"></td><td>)</td>
  184. <td></td>
  185. </tr>
  186. </table>
  187. </div><div class="memdoc">
  188. </div>
  189. </div>
  190. <h2 class="groupheader">Member Function Documentation</h2>
  191. <a class="anchor" id="a185b593e5c7d2b888fa377989a6bae80"></a>
  192. <div class="memitem">
  193. <div class="memproto">
  194. <table class="memname">
  195. <tr>
  196. <td class="memname">void grpc::ByteBuffer::Clear </td>
  197. <td>(</td>
  198. <td class="paramname"></td><td>)</td>
  199. <td></td>
  200. </tr>
  201. </table>
  202. </div><div class="memdoc">
  203. <p>Remove all data. </p>
  204. </div>
  205. </div>
  206. <a class="anchor" id="a1b284d25c0c3c594c386800c548048f1"></a>
  207. <div class="memitem">
  208. <div class="memproto">
  209. <table class="memname">
  210. <tr>
  211. <td class="memname">void grpc::ByteBuffer::Dump </td>
  212. <td>(</td>
  213. <td class="paramtype">std::vector&lt; <a class="el" href="classgrpc_1_1_slice.html">Slice</a> &gt; *&#160;</td>
  214. <td class="paramname"><em>slices</em></td><td>)</td>
  215. <td> const</td>
  216. </tr>
  217. </table>
  218. </div><div class="memdoc">
  219. <p>Dump (read) the buffer contents into <em>slices</em>. </p>
  220. </div>
  221. </div>
  222. <a class="anchor" id="a9429e928982f8d94ff93a1a91032ad59"></a>
  223. <div class="memitem">
  224. <div class="memproto">
  225. <table class="memname">
  226. <tr>
  227. <td class="memname">size_t grpc::ByteBuffer::Length </td>
  228. <td>(</td>
  229. <td class="paramname"></td><td>)</td>
  230. <td> const</td>
  231. </tr>
  232. </table>
  233. </div><div class="memdoc">
  234. <p>Buffer size in bytes. </p>
  235. </div>
  236. </div>
  237. <h2 class="groupheader">Friends And Related Function Documentation</h2>
  238. <a class="anchor" id="ab90fe50537dd6fe009b7b913652420f0"></a>
  239. <div class="memitem">
  240. <div class="memproto">
  241. <table class="mlabels">
  242. <tr>
  243. <td class="mlabels-left">
  244. <table class="memname">
  245. <tr>
  246. <td class="memname">friend class <a class="el" href="classgrpc_1_1_serialization_traits.html">SerializationTraits</a>&lt; <a class="el" href="classgrpc_1_1_byte_buffer.html">ByteBuffer</a>, void &gt;</td>
  247. </tr>
  248. </table>
  249. </td>
  250. <td class="mlabels-right">
  251. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  252. </tr>
  253. </table>
  254. </div><div class="memdoc">
  255. </div>
  256. </div>
  257. <hr/>The documentation for this class was generated from the following file:<ul>
  258. <li>include/grpc++/support/<a class="el" href="byte__buffer_8h_source.html">byte_buffer.h</a></li>
  259. </ul>
  260. </div><!-- contents -->
  261. <!-- start footer part -->
  262. <hr class="footer"/><address class="footer"><small>
  263. Generated on Tue Oct 27 2015 21:07:30 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  264. <img class="footer" src="doxygen.png" alt="doxygen"/>
  265. </a> 1.8.6
  266. </small></address>
  267. </body>
  268. </html>