classgrpc_1_1_byte_buffer.html 16 KB

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