grpc_2impl_2codegen_2byte__buffer_8h.html 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440
  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++: include/grpc/impl/codegen/byte_buffer.h File 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><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  45. <li class="current"><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="files.html"><span>File&#160;List</span></a></li>
  67. <li><a href="globals.html"><span>Globals</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. </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="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_9d7a14d6d9adcbe4c35dbdb88d867e2e.html">grpc</a></li><li class="navelem"><a class="el" href="dir_4b3e2ed696753daba329e2683e0f6479.html">impl</a></li><li class="navelem"><a class="el" href="dir_7a167954ab48275cc692d783196d1f28.html">codegen</a></li> </ul>
  85. </div>
  86. </div><!-- top -->
  87. <div class="header">
  88. <div class="summary">
  89. <a href="#nested-classes">Data Structures</a> &#124;
  90. <a href="#typedef-members">Typedefs</a> &#124;
  91. <a href="#enum-members">Enumerations</a> &#124;
  92. <a href="#func-members">Functions</a> </div>
  93. <div class="headertitle">
  94. <div class="title">byte_buffer.h File Reference</div> </div>
  95. </div><!--header-->
  96. <div class="contents">
  97. <div class="textblock"><code>#include &lt;<a class="el" href="compression__types_8h_source.html">grpc/impl/codegen/compression_types.h</a>&gt;</code><br />
  98. <code>#include &lt;<a class="el" href="slice__buffer_8h_source.html">grpc/impl/codegen/slice_buffer.h</a>&gt;</code><br />
  99. </div>
  100. <p><a href="grpc_2impl_2codegen_2byte__buffer_8h_source.html">Go to the source code of this file.</a></p>
  101. <table class="memberdecls">
  102. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  103. Data Structures</h2></td></tr>
  104. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__byte__buffer.html">grpc_byte_buffer</a></td></tr>
  105. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. </table><table class="memberdecls">
  107. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
  108. Typedefs</h2></td></tr>
  109. <tr class="memitem:a670951ae03b0a2dc4e50f4e25160fc2e"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structgrpc__byte__buffer.html">grpc_byte_buffer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc_2impl_2codegen_2byte__buffer_8h.html#a670951ae03b0a2dc4e50f4e25160fc2e">grpc_byte_buffer</a></td></tr>
  110. <tr class="separator:a670951ae03b0a2dc4e50f4e25160fc2e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:a16143f22ea46cc7fa6b53e6cb30715f1"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structgrpc__byte__buffer__reader.html">grpc_byte_buffer_reader</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc_2impl_2codegen_2byte__buffer_8h.html#a16143f22ea46cc7fa6b53e6cb30715f1">grpc_byte_buffer_reader</a></td></tr>
  112. <tr class="separator:a16143f22ea46cc7fa6b53e6cb30715f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. </table><table class="memberdecls">
  114. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
  115. Enumerations</h2></td></tr>
  116. <tr class="memitem:acdc94363b280bde9c82e3d9b5dc3b3e6"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc_2impl_2codegen_2byte__buffer_8h.html#acdc94363b280bde9c82e3d9b5dc3b3e6">grpc_byte_buffer_type</a> { <a class="el" href="grpc_2impl_2codegen_2byte__buffer_8h.html#acdc94363b280bde9c82e3d9b5dc3b3e6a1918bbb8502c74288793b58f1786f636">GRPC_BB_RAW</a>
  117. }</td></tr>
  118. <tr class="separator:acdc94363b280bde9c82e3d9b5dc3b3e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. </table><table class="memberdecls">
  120. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  121. Functions</h2></td></tr>
  122. <tr class="memitem:ae306bd97b96934d1036c5fdea5846d27"><td class="memItemLeft" align="right" valign="top"><a class="el" href="port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="structgrpc__byte__buffer.html">grpc_byte_buffer</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc_2impl_2codegen_2byte__buffer_8h.html#ae306bd97b96934d1036c5fdea5846d27">grpc_raw_byte_buffer_create</a> (<a class="el" href="structgpr__slice.html">gpr_slice</a> *slices, size_t nslices)</td></tr>
  123. <tr class="memdesc:ae306bd97b96934d1036c5fdea5846d27"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a RAW byte buffer instance over the given slices (up to <em>nslices</em>). <a href="#ae306bd97b96934d1036c5fdea5846d27">More...</a><br /></td></tr>
  124. <tr class="separator:ae306bd97b96934d1036c5fdea5846d27"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <tr class="memitem:aa764b246829ea071a28d2b5102298661"><td class="memItemLeft" align="right" valign="top"><a class="el" href="port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="structgrpc__byte__buffer.html">grpc_byte_buffer</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc_2impl_2codegen_2byte__buffer_8h.html#aa764b246829ea071a28d2b5102298661">grpc_raw_compressed_byte_buffer_create</a> (<a class="el" href="structgpr__slice.html">gpr_slice</a> *slices, size_t nslices, <a class="el" href="compression__types_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a> compression)</td></tr>
  126. <tr class="memdesc:aa764b246829ea071a28d2b5102298661"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a <em>compressed</em> RAW byte buffer instance over the given slices (up to <em>nslices</em>). <a href="#aa764b246829ea071a28d2b5102298661">More...</a><br /></td></tr>
  127. <tr class="separator:aa764b246829ea071a28d2b5102298661"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:a4ebb8f0714bee2c84fed0be62d0dc259"><td class="memItemLeft" align="right" valign="top"><a class="el" href="port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="structgrpc__byte__buffer.html">grpc_byte_buffer</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc_2impl_2codegen_2byte__buffer_8h.html#a4ebb8f0714bee2c84fed0be62d0dc259">grpc_byte_buffer_copy</a> (<a class="el" href="structgrpc__byte__buffer.html">grpc_byte_buffer</a> *bb)</td></tr>
  129. <tr class="memdesc:a4ebb8f0714bee2c84fed0be62d0dc259"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copies input byte buffer <em>bb</em>. <a href="#a4ebb8f0714bee2c84fed0be62d0dc259">More...</a><br /></td></tr>
  130. <tr class="separator:a4ebb8f0714bee2c84fed0be62d0dc259"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:a9532c0f54de763057e185a950368b0bb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc_2impl_2codegen_2byte__buffer_8h.html#a9532c0f54de763057e185a950368b0bb">grpc_byte_buffer_length</a> (<a class="el" href="structgrpc__byte__buffer.html">grpc_byte_buffer</a> *bb)</td></tr>
  132. <tr class="memdesc:a9532c0f54de763057e185a950368b0bb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the size of the given byte buffer, in bytes. <a href="#a9532c0f54de763057e185a950368b0bb">More...</a><br /></td></tr>
  133. <tr class="separator:a9532c0f54de763057e185a950368b0bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <tr class="memitem:a32c878db8b0a48035ce777844360a6f0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc_2impl_2codegen_2byte__buffer_8h.html#a32c878db8b0a48035ce777844360a6f0">grpc_byte_buffer_destroy</a> (<a class="el" href="structgrpc__byte__buffer.html">grpc_byte_buffer</a> *byte_buffer)</td></tr>
  135. <tr class="memdesc:a32c878db8b0a48035ce777844360a6f0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroys <em>byte_buffer</em> deallocating all its memory. <a href="#a32c878db8b0a48035ce777844360a6f0">More...</a><br /></td></tr>
  136. <tr class="separator:a32c878db8b0a48035ce777844360a6f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <tr class="memitem:affd8fb29176a60c44fe704983fa87406"><td class="memItemLeft" align="right" valign="top"><a class="el" href="port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc_2impl_2codegen_2byte__buffer_8h.html#affd8fb29176a60c44fe704983fa87406">grpc_byte_buffer_reader_init</a> (<a class="el" href="structgrpc__byte__buffer__reader.html">grpc_byte_buffer_reader</a> *reader, <a class="el" href="structgrpc__byte__buffer.html">grpc_byte_buffer</a> *buffer)</td></tr>
  138. <tr class="memdesc:affd8fb29176a60c44fe704983fa87406"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize <em>reader</em> to read over <em>buffer</em>. <a href="#affd8fb29176a60c44fe704983fa87406">More...</a><br /></td></tr>
  139. <tr class="separator:affd8fb29176a60c44fe704983fa87406"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <tr class="memitem:ae28a4ce16b0d8ddd506f1df3fcb3c619"><td class="memItemLeft" align="right" valign="top"><a class="el" href="port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc_2impl_2codegen_2byte__buffer_8h.html#ae28a4ce16b0d8ddd506f1df3fcb3c619">grpc_byte_buffer_reader_destroy</a> (<a class="el" href="structgrpc__byte__buffer__reader.html">grpc_byte_buffer_reader</a> *reader)</td></tr>
  141. <tr class="memdesc:ae28a4ce16b0d8ddd506f1df3fcb3c619"><td class="mdescLeft">&#160;</td><td class="mdescRight">Cleanup and destroy <em>reader</em>. <a href="#ae28a4ce16b0d8ddd506f1df3fcb3c619">More...</a><br /></td></tr>
  142. <tr class="separator:ae28a4ce16b0d8ddd506f1df3fcb3c619"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <tr class="memitem:a1b17c75d41324ce679dfe18307786576"><td class="memItemLeft" align="right" valign="top"><a class="el" href="port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc_2impl_2codegen_2byte__buffer_8h.html#a1b17c75d41324ce679dfe18307786576">grpc_byte_buffer_reader_next</a> (<a class="el" href="structgrpc__byte__buffer__reader.html">grpc_byte_buffer_reader</a> *reader, <a class="el" href="structgpr__slice.html">gpr_slice</a> *slice)</td></tr>
  144. <tr class="memdesc:a1b17c75d41324ce679dfe18307786576"><td class="mdescLeft">&#160;</td><td class="mdescRight">Updates <em>slice</em> with the next piece of data from from <em>reader</em> and returns. <a href="#a1b17c75d41324ce679dfe18307786576">More...</a><br /></td></tr>
  145. <tr class="separator:a1b17c75d41324ce679dfe18307786576"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. <tr class="memitem:a489d2efbfcc2dcc65a21380cc183ade3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="structgpr__slice.html">gpr_slice</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc_2impl_2codegen_2byte__buffer_8h.html#a489d2efbfcc2dcc65a21380cc183ade3">grpc_byte_buffer_reader_readall</a> (<a class="el" href="structgrpc__byte__buffer__reader.html">grpc_byte_buffer_reader</a> *reader)</td></tr>
  147. <tr class="memdesc:a489d2efbfcc2dcc65a21380cc183ade3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Merge all data from <em>reader</em> into single slice. <a href="#a489d2efbfcc2dcc65a21380cc183ade3">More...</a><br /></td></tr>
  148. <tr class="separator:a489d2efbfcc2dcc65a21380cc183ade3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  149. <tr class="memitem:ac7407c6fa60073adb166ca4f3cfbc8e7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="structgrpc__byte__buffer.html">grpc_byte_buffer</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc_2impl_2codegen_2byte__buffer_8h.html#ac7407c6fa60073adb166ca4f3cfbc8e7">grpc_raw_byte_buffer_from_reader</a> (<a class="el" href="structgrpc__byte__buffer__reader.html">grpc_byte_buffer_reader</a> *reader)</td></tr>
  150. <tr class="memdesc:ac7407c6fa60073adb166ca4f3cfbc8e7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a RAW byte buffer instance from the output of <em>reader</em>. <a href="#ac7407c6fa60073adb166ca4f3cfbc8e7">More...</a><br /></td></tr>
  151. <tr class="separator:ac7407c6fa60073adb166ca4f3cfbc8e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  152. </table>
  153. <h2 class="groupheader">Typedef Documentation</h2>
  154. <a class="anchor" id="a670951ae03b0a2dc4e50f4e25160fc2e"></a>
  155. <div class="memitem">
  156. <div class="memproto">
  157. <table class="memname">
  158. <tr>
  159. <td class="memname">typedef struct <a class="el" href="structgrpc__byte__buffer.html">grpc_byte_buffer</a> <a class="el" href="structgrpc__byte__buffer.html">grpc_byte_buffer</a></td>
  160. </tr>
  161. </table>
  162. </div><div class="memdoc">
  163. </div>
  164. </div>
  165. <a class="anchor" id="a16143f22ea46cc7fa6b53e6cb30715f1"></a>
  166. <div class="memitem">
  167. <div class="memproto">
  168. <table class="memname">
  169. <tr>
  170. <td class="memname">typedef struct <a class="el" href="structgrpc__byte__buffer__reader.html">grpc_byte_buffer_reader</a> <a class="el" href="structgrpc__byte__buffer__reader.html">grpc_byte_buffer_reader</a></td>
  171. </tr>
  172. </table>
  173. </div><div class="memdoc">
  174. </div>
  175. </div>
  176. <h2 class="groupheader">Enumeration Type Documentation</h2>
  177. <a class="anchor" id="acdc94363b280bde9c82e3d9b5dc3b3e6"></a>
  178. <div class="memitem">
  179. <div class="memproto">
  180. <table class="memname">
  181. <tr>
  182. <td class="memname">enum <a class="el" href="grpc_2impl_2codegen_2byte__buffer_8h.html#acdc94363b280bde9c82e3d9b5dc3b3e6">grpc_byte_buffer_type</a></td>
  183. </tr>
  184. </table>
  185. </div><div class="memdoc">
  186. <table class="fieldtable">
  187. <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="acdc94363b280bde9c82e3d9b5dc3b3e6a1918bbb8502c74288793b58f1786f636"></a>GRPC_BB_RAW&#160;</td><td class="fielddoc">
  188. </td></tr>
  189. </table>
  190. </div>
  191. </div>
  192. <h2 class="groupheader">Function Documentation</h2>
  193. <a class="anchor" id="a4ebb8f0714bee2c84fed0be62d0dc259"></a>
  194. <div class="memitem">
  195. <div class="memproto">
  196. <table class="memname">
  197. <tr>
  198. <td class="memname"><a class="el" href="port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="structgrpc__byte__buffer.html">grpc_byte_buffer</a>* grpc_byte_buffer_copy </td>
  199. <td>(</td>
  200. <td class="paramtype"><a class="el" href="structgrpc__byte__buffer.html">grpc_byte_buffer</a> *&#160;</td>
  201. <td class="paramname"><em>bb</em></td><td>)</td>
  202. <td></td>
  203. </tr>
  204. </table>
  205. </div><div class="memdoc">
  206. <p>Copies input byte buffer <em>bb</em>. </p>
  207. <p>Increases the reference count of all the source slices. The user is responsible for calling grpc_byte_buffer_destroy over the returned copy. </p>
  208. </div>
  209. </div>
  210. <a class="anchor" id="a32c878db8b0a48035ce777844360a6f0"></a>
  211. <div class="memitem">
  212. <div class="memproto">
  213. <table class="memname">
  214. <tr>
  215. <td class="memname"><a class="el" href="port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> void grpc_byte_buffer_destroy </td>
  216. <td>(</td>
  217. <td class="paramtype"><a class="el" href="structgrpc__byte__buffer.html">grpc_byte_buffer</a> *&#160;</td>
  218. <td class="paramname"><em>byte_buffer</em></td><td>)</td>
  219. <td></td>
  220. </tr>
  221. </table>
  222. </div><div class="memdoc">
  223. <p>Destroys <em>byte_buffer</em> deallocating all its memory. </p>
  224. </div>
  225. </div>
  226. <a class="anchor" id="a9532c0f54de763057e185a950368b0bb"></a>
  227. <div class="memitem">
  228. <div class="memproto">
  229. <table class="memname">
  230. <tr>
  231. <td class="memname"><a class="el" href="port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> size_t grpc_byte_buffer_length </td>
  232. <td>(</td>
  233. <td class="paramtype"><a class="el" href="structgrpc__byte__buffer.html">grpc_byte_buffer</a> *&#160;</td>
  234. <td class="paramname"><em>bb</em></td><td>)</td>
  235. <td></td>
  236. </tr>
  237. </table>
  238. </div><div class="memdoc">
  239. <p>Returns the size of the given byte buffer, in bytes. </p>
  240. </div>
  241. </div>
  242. <a class="anchor" id="ae28a4ce16b0d8ddd506f1df3fcb3c619"></a>
  243. <div class="memitem">
  244. <div class="memproto">
  245. <table class="memname">
  246. <tr>
  247. <td class="memname"><a class="el" href="port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> void grpc_byte_buffer_reader_destroy </td>
  248. <td>(</td>
  249. <td class="paramtype"><a class="el" href="structgrpc__byte__buffer__reader.html">grpc_byte_buffer_reader</a> *&#160;</td>
  250. <td class="paramname"><em>reader</em></td><td>)</td>
  251. <td></td>
  252. </tr>
  253. </table>
  254. </div><div class="memdoc">
  255. <p>Cleanup and destroy <em>reader</em>. </p>
  256. </div>
  257. </div>
  258. <a class="anchor" id="affd8fb29176a60c44fe704983fa87406"></a>
  259. <div class="memitem">
  260. <div class="memproto">
  261. <table class="memname">
  262. <tr>
  263. <td class="memname"><a class="el" href="port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> int grpc_byte_buffer_reader_init </td>
  264. <td>(</td>
  265. <td class="paramtype"><a class="el" href="structgrpc__byte__buffer__reader.html">grpc_byte_buffer_reader</a> *&#160;</td>
  266. <td class="paramname"><em>reader</em>, </td>
  267. </tr>
  268. <tr>
  269. <td class="paramkey"></td>
  270. <td></td>
  271. <td class="paramtype"><a class="el" href="structgrpc__byte__buffer.html">grpc_byte_buffer</a> *&#160;</td>
  272. <td class="paramname"><em>buffer</em>&#160;</td>
  273. </tr>
  274. <tr>
  275. <td></td>
  276. <td>)</td>
  277. <td></td><td></td>
  278. </tr>
  279. </table>
  280. </div><div class="memdoc">
  281. <p>Initialize <em>reader</em> to read over <em>buffer</em>. </p>
  282. <p>Returns 1 upon success, 0 otherwise. </p>
  283. </div>
  284. </div>
  285. <a class="anchor" id="a1b17c75d41324ce679dfe18307786576"></a>
  286. <div class="memitem">
  287. <div class="memproto">
  288. <table class="memname">
  289. <tr>
  290. <td class="memname"><a class="el" href="port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> int grpc_byte_buffer_reader_next </td>
  291. <td>(</td>
  292. <td class="paramtype"><a class="el" href="structgrpc__byte__buffer__reader.html">grpc_byte_buffer_reader</a> *&#160;</td>
  293. <td class="paramname"><em>reader</em>, </td>
  294. </tr>
  295. <tr>
  296. <td class="paramkey"></td>
  297. <td></td>
  298. <td class="paramtype"><a class="el" href="structgpr__slice.html">gpr_slice</a> *&#160;</td>
  299. <td class="paramname"><em>slice</em>&#160;</td>
  300. </tr>
  301. <tr>
  302. <td></td>
  303. <td>)</td>
  304. <td></td><td></td>
  305. </tr>
  306. </table>
  307. </div><div class="memdoc">
  308. <p>Updates <em>slice</em> with the next piece of data from from <em>reader</em> and returns. </p>
  309. <ol type="1">
  310. <li>Returns 0 at the end of the stream. Caller is responsible for calling gpr_slice_unref on the result. </li>
  311. </ol>
  312. </div>
  313. </div>
  314. <a class="anchor" id="a489d2efbfcc2dcc65a21380cc183ade3"></a>
  315. <div class="memitem">
  316. <div class="memproto">
  317. <table class="memname">
  318. <tr>
  319. <td class="memname"><a class="el" href="port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="structgpr__slice.html">gpr_slice</a> grpc_byte_buffer_reader_readall </td>
  320. <td>(</td>
  321. <td class="paramtype"><a class="el" href="structgrpc__byte__buffer__reader.html">grpc_byte_buffer_reader</a> *&#160;</td>
  322. <td class="paramname"><em>reader</em></td><td>)</td>
  323. <td></td>
  324. </tr>
  325. </table>
  326. </div><div class="memdoc">
  327. <p>Merge all data from <em>reader</em> into single slice. </p>
  328. </div>
  329. </div>
  330. <a class="anchor" id="ae306bd97b96934d1036c5fdea5846d27"></a>
  331. <div class="memitem">
  332. <div class="memproto">
  333. <table class="memname">
  334. <tr>
  335. <td class="memname"><a class="el" href="port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="structgrpc__byte__buffer.html">grpc_byte_buffer</a>* grpc_raw_byte_buffer_create </td>
  336. <td>(</td>
  337. <td class="paramtype"><a class="el" href="structgpr__slice.html">gpr_slice</a> *&#160;</td>
  338. <td class="paramname"><em>slices</em>, </td>
  339. </tr>
  340. <tr>
  341. <td class="paramkey"></td>
  342. <td></td>
  343. <td class="paramtype">size_t&#160;</td>
  344. <td class="paramname"><em>nslices</em>&#160;</td>
  345. </tr>
  346. <tr>
  347. <td></td>
  348. <td>)</td>
  349. <td></td><td></td>
  350. </tr>
  351. </table>
  352. </div><div class="memdoc">
  353. <p>Returns a RAW byte buffer instance over the given slices (up to <em>nslices</em>). </p>
  354. <p>Increases the reference count for all <em>slices</em> processed. The user is responsible for invoking grpc_byte_buffer_destroy on the returned instance. </p>
  355. </div>
  356. </div>
  357. <a class="anchor" id="ac7407c6fa60073adb166ca4f3cfbc8e7"></a>
  358. <div class="memitem">
  359. <div class="memproto">
  360. <table class="memname">
  361. <tr>
  362. <td class="memname"><a class="el" href="port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="structgrpc__byte__buffer.html">grpc_byte_buffer</a>* grpc_raw_byte_buffer_from_reader </td>
  363. <td>(</td>
  364. <td class="paramtype"><a class="el" href="structgrpc__byte__buffer__reader.html">grpc_byte_buffer_reader</a> *&#160;</td>
  365. <td class="paramname"><em>reader</em></td><td>)</td>
  366. <td></td>
  367. </tr>
  368. </table>
  369. </div><div class="memdoc">
  370. <p>Returns a RAW byte buffer instance from the output of <em>reader</em>. </p>
  371. </div>
  372. </div>
  373. <a class="anchor" id="aa764b246829ea071a28d2b5102298661"></a>
  374. <div class="memitem">
  375. <div class="memproto">
  376. <table class="memname">
  377. <tr>
  378. <td class="memname"><a class="el" href="port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="structgrpc__byte__buffer.html">grpc_byte_buffer</a>* grpc_raw_compressed_byte_buffer_create </td>
  379. <td>(</td>
  380. <td class="paramtype"><a class="el" href="structgpr__slice.html">gpr_slice</a> *&#160;</td>
  381. <td class="paramname"><em>slices</em>, </td>
  382. </tr>
  383. <tr>
  384. <td class="paramkey"></td>
  385. <td></td>
  386. <td class="paramtype">size_t&#160;</td>
  387. <td class="paramname"><em>nslices</em>, </td>
  388. </tr>
  389. <tr>
  390. <td class="paramkey"></td>
  391. <td></td>
  392. <td class="paramtype"><a class="el" href="compression__types_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a>&#160;</td>
  393. <td class="paramname"><em>compression</em>&#160;</td>
  394. </tr>
  395. <tr>
  396. <td></td>
  397. <td>)</td>
  398. <td></td><td></td>
  399. </tr>
  400. </table>
  401. </div><div class="memdoc">
  402. <p>Returns a <em>compressed</em> RAW byte buffer instance over the given slices (up to <em>nslices</em>). </p>
  403. <p>The <em>compression</em> argument defines the compression algorithm used to generate the data in <em>slices</em>.</p>
  404. <p>Increases the reference count for all <em>slices</em> processed. The user is responsible for invoking grpc_byte_buffer_destroy on the returned instance. </p>
  405. </div>
  406. </div>
  407. </div><!-- contents -->
  408. <!-- start footer part -->
  409. <hr class="footer"/><address class="footer"><small>
  410. Generated on Thu Aug 18 2016 21:34:58 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  411. <img class="footer" src="doxygen.png" alt="doxygen"/>
  412. </a> 1.8.11
  413. </small></address>
  414. </body>
  415. </html>