impl_2codegen_2byte__buffer_8h.html 27 KB

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