byte__buffer_8h.html 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396
  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 Core: include/grpc/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/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 Core
  26. &#160;<span id="projectnumber">4.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="pages.html"><span>Related&#160;Pages</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. <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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Pages</a></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_bda73758a0a4d8c0ff603a7983866e1c.html">include</a></li><li class="navelem"><a class="el" href="dir_8ae8e534eeef321a81935092729b7078.html">grpc</a></li> </ul>
  84. </div>
  85. </div><!-- top -->
  86. <div class="header">
  87. <div class="summary">
  88. <a href="#typedef-members">Typedefs</a> &#124;
  89. <a href="#func-members">Functions</a> </div>
  90. <div class="headertitle">
  91. <div class="title">byte_buffer.h File Reference</div> </div>
  92. </div><!--header-->
  93. <div class="contents">
  94. <div class="textblock"><code>#include &lt;<a class="el" href="grpc__types_8h_source.html">grpc/impl/codegen/grpc_types.h</a>&gt;</code><br/>
  95. <code>#include &lt;<a class="el" href="slice__buffer_8h_source.html">grpc/slice_buffer.h</a>&gt;</code><br/>
  96. </div>
  97. <p><a href="byte__buffer_8h_source.html">Go to the source code of this file.</a></p>
  98. <table class="memberdecls">
  99. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
  100. Typedefs</h2></td></tr>
  101. <tr class="memitem:a16143f22ea46cc7fa6b53e6cb30715f1"><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/>
  102. <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="byte__buffer_8h.html#a16143f22ea46cc7fa6b53e6cb30715f1">grpc_byte_buffer_reader</a></td></tr>
  103. <tr class="separator:a16143f22ea46cc7fa6b53e6cb30715f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. </table><table class="memberdecls">
  105. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  106. Functions</h2></td></tr>
  107. <tr class="memitem:a5ab72d6615ee89c975c46ad4e50c1387"><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="byte__buffer_8h.html#a5ab72d6615ee89c975c46ad4e50c1387">grpc_raw_byte_buffer_create</a> (<a class="el" href="structgrpc__slice.html">grpc_slice</a> *slices, size_t nslices)</td></tr>
  108. <tr class="memdesc:a5ab72d6615ee89c975c46ad4e50c1387"><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="#a5ab72d6615ee89c975c46ad4e50c1387">More...</a><br/></td></tr>
  109. <tr class="separator:a5ab72d6615ee89c975c46ad4e50c1387"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="memitem:a49ca36baa74fa2f9ae0c615bf53cec7d"><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="byte__buffer_8h.html#a49ca36baa74fa2f9ae0c615bf53cec7d">grpc_raw_compressed_byte_buffer_create</a> (<a class="el" href="structgrpc__slice.html">grpc_slice</a> *slices, size_t nslices, <a class="el" href="compression__types_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a> compression)</td></tr>
  111. <tr class="memdesc:a49ca36baa74fa2f9ae0c615bf53cec7d"><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="#a49ca36baa74fa2f9ae0c615bf53cec7d">More...</a><br/></td></tr>
  112. <tr class="separator:a49ca36baa74fa2f9ae0c615bf53cec7d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <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="byte__buffer_8h.html#a4ebb8f0714bee2c84fed0be62d0dc259">grpc_byte_buffer_copy</a> (<a class="el" href="structgrpc__byte__buffer.html">grpc_byte_buffer</a> *bb)</td></tr>
  114. <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>
  115. <tr class="separator:a4ebb8f0714bee2c84fed0be62d0dc259"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. <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="byte__buffer_8h.html#a9532c0f54de763057e185a950368b0bb">grpc_byte_buffer_length</a> (<a class="el" href="structgrpc__byte__buffer.html">grpc_byte_buffer</a> *bb)</td></tr>
  117. <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>
  118. <tr class="separator:a9532c0f54de763057e185a950368b0bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. <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="byte__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>
  120. <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>
  121. <tr class="separator:a32c878db8b0a48035ce777844360a6f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <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="byte__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>
  123. <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>
  124. <tr class="separator:affd8fb29176a60c44fe704983fa87406"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <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="byte__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>
  126. <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>
  127. <tr class="separator:ae28a4ce16b0d8ddd506f1df3fcb3c619"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:a8352c7f73cf930c8195e547bd1a5a242"><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="byte__buffer_8h.html#a8352c7f73cf930c8195e547bd1a5a242">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="structgrpc__slice.html">grpc_slice</a> *slice)</td></tr>
  129. <tr class="memdesc:a8352c7f73cf930c8195e547bd1a5a242"><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="#a8352c7f73cf930c8195e547bd1a5a242">More...</a><br/></td></tr>
  130. <tr class="separator:a8352c7f73cf930c8195e547bd1a5a242"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:a4cbf1eb762ea3c6c08bcfc46201c7691"><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__slice.html">grpc_slice</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="byte__buffer_8h.html#a4cbf1eb762ea3c6c08bcfc46201c7691">grpc_byte_buffer_reader_readall</a> (<a class="el" href="structgrpc__byte__buffer__reader.html">grpc_byte_buffer_reader</a> *reader)</td></tr>
  132. <tr class="memdesc:a4cbf1eb762ea3c6c08bcfc46201c7691"><td class="mdescLeft">&#160;</td><td class="mdescRight">Merge all data from <em>reader</em> into single slice. <a href="#a4cbf1eb762ea3c6c08bcfc46201c7691">More...</a><br/></td></tr>
  133. <tr class="separator:a4cbf1eb762ea3c6c08bcfc46201c7691"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <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="byte__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>
  135. <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>
  136. <tr class="separator:ac7407c6fa60073adb166ca4f3cfbc8e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. </table>
  138. <h2 class="groupheader">Typedef Documentation</h2>
  139. <a class="anchor" id="a16143f22ea46cc7fa6b53e6cb30715f1"></a>
  140. <div class="memitem">
  141. <div class="memproto">
  142. <table class="memname">
  143. <tr>
  144. <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>
  145. </tr>
  146. </table>
  147. </div><div class="memdoc">
  148. </div>
  149. </div>
  150. <h2 class="groupheader">Function Documentation</h2>
  151. <a class="anchor" id="a4ebb8f0714bee2c84fed0be62d0dc259"></a>
  152. <div class="memitem">
  153. <div class="memproto">
  154. <table class="memname">
  155. <tr>
  156. <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>
  157. <td>(</td>
  158. <td class="paramtype"><a class="el" href="structgrpc__byte__buffer.html">grpc_byte_buffer</a> *&#160;</td>
  159. <td class="paramname"><em>bb</em></td><td>)</td>
  160. <td></td>
  161. </tr>
  162. </table>
  163. </div><div class="memdoc">
  164. <p>Copies input byte buffer <em>bb</em>. </p>
  165. <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>
  166. </div>
  167. </div>
  168. <a class="anchor" id="a32c878db8b0a48035ce777844360a6f0"></a>
  169. <div class="memitem">
  170. <div class="memproto">
  171. <table class="memname">
  172. <tr>
  173. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> void grpc_byte_buffer_destroy </td>
  174. <td>(</td>
  175. <td class="paramtype"><a class="el" href="structgrpc__byte__buffer.html">grpc_byte_buffer</a> *&#160;</td>
  176. <td class="paramname"><em>byte_buffer</em></td><td>)</td>
  177. <td></td>
  178. </tr>
  179. </table>
  180. </div><div class="memdoc">
  181. <p>Destroys <em>byte_buffer</em> deallocating all its memory. </p>
  182. </div>
  183. </div>
  184. <a class="anchor" id="a9532c0f54de763057e185a950368b0bb"></a>
  185. <div class="memitem">
  186. <div class="memproto">
  187. <table class="memname">
  188. <tr>
  189. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> size_t grpc_byte_buffer_length </td>
  190. <td>(</td>
  191. <td class="paramtype"><a class="el" href="structgrpc__byte__buffer.html">grpc_byte_buffer</a> *&#160;</td>
  192. <td class="paramname"><em>bb</em></td><td>)</td>
  193. <td></td>
  194. </tr>
  195. </table>
  196. </div><div class="memdoc">
  197. <p>Returns the size of the given byte buffer, in bytes. </p>
  198. </div>
  199. </div>
  200. <a class="anchor" id="ae28a4ce16b0d8ddd506f1df3fcb3c619"></a>
  201. <div class="memitem">
  202. <div class="memproto">
  203. <table class="memname">
  204. <tr>
  205. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> void grpc_byte_buffer_reader_destroy </td>
  206. <td>(</td>
  207. <td class="paramtype"><a class="el" href="structgrpc__byte__buffer__reader.html">grpc_byte_buffer_reader</a> *&#160;</td>
  208. <td class="paramname"><em>reader</em></td><td>)</td>
  209. <td></td>
  210. </tr>
  211. </table>
  212. </div><div class="memdoc">
  213. <p>Cleanup and destroy <em>reader</em>. </p>
  214. </div>
  215. </div>
  216. <a class="anchor" id="affd8fb29176a60c44fe704983fa87406"></a>
  217. <div class="memitem">
  218. <div class="memproto">
  219. <table class="memname">
  220. <tr>
  221. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> int grpc_byte_buffer_reader_init </td>
  222. <td>(</td>
  223. <td class="paramtype"><a class="el" href="structgrpc__byte__buffer__reader.html">grpc_byte_buffer_reader</a> *&#160;</td>
  224. <td class="paramname"><em>reader</em>, </td>
  225. </tr>
  226. <tr>
  227. <td class="paramkey"></td>
  228. <td></td>
  229. <td class="paramtype"><a class="el" href="structgrpc__byte__buffer.html">grpc_byte_buffer</a> *&#160;</td>
  230. <td class="paramname"><em>buffer</em>&#160;</td>
  231. </tr>
  232. <tr>
  233. <td></td>
  234. <td>)</td>
  235. <td></td><td></td>
  236. </tr>
  237. </table>
  238. </div><div class="memdoc">
  239. <p>Initialize <em>reader</em> to read over <em>buffer</em>. </p>
  240. <p>Returns 1 upon success, 0 otherwise. </p>
  241. </div>
  242. </div>
  243. <a class="anchor" id="a8352c7f73cf930c8195e547bd1a5a242"></a>
  244. <div class="memitem">
  245. <div class="memproto">
  246. <table class="memname">
  247. <tr>
  248. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> int grpc_byte_buffer_reader_next </td>
  249. <td>(</td>
  250. <td class="paramtype"><a class="el" href="structgrpc__byte__buffer__reader.html">grpc_byte_buffer_reader</a> *&#160;</td>
  251. <td class="paramname"><em>reader</em>, </td>
  252. </tr>
  253. <tr>
  254. <td class="paramkey"></td>
  255. <td></td>
  256. <td class="paramtype"><a class="el" href="structgrpc__slice.html">grpc_slice</a> *&#160;</td>
  257. <td class="paramname"><em>slice</em>&#160;</td>
  258. </tr>
  259. <tr>
  260. <td></td>
  261. <td>)</td>
  262. <td></td><td></td>
  263. </tr>
  264. </table>
  265. </div><div class="memdoc">
  266. <p>Updates <em>slice</em> with the next piece of data from from <em>reader</em> and returns. </p>
  267. <ol type="1">
  268. <li>Returns 0 at the end of the stream. Caller is responsible for calling grpc_slice_unref on the result. </li>
  269. </ol>
  270. </div>
  271. </div>
  272. <a class="anchor" id="a4cbf1eb762ea3c6c08bcfc46201c7691"></a>
  273. <div class="memitem">
  274. <div class="memproto">
  275. <table class="memname">
  276. <tr>
  277. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="structgrpc__slice.html">grpc_slice</a> grpc_byte_buffer_reader_readall </td>
  278. <td>(</td>
  279. <td class="paramtype"><a class="el" href="structgrpc__byte__buffer__reader.html">grpc_byte_buffer_reader</a> *&#160;</td>
  280. <td class="paramname"><em>reader</em></td><td>)</td>
  281. <td></td>
  282. </tr>
  283. </table>
  284. </div><div class="memdoc">
  285. <p>Merge all data from <em>reader</em> into single slice. </p>
  286. </div>
  287. </div>
  288. <a class="anchor" id="a5ab72d6615ee89c975c46ad4e50c1387"></a>
  289. <div class="memitem">
  290. <div class="memproto">
  291. <table class="memname">
  292. <tr>
  293. <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>
  294. <td>(</td>
  295. <td class="paramtype"><a class="el" href="structgrpc__slice.html">grpc_slice</a> *&#160;</td>
  296. <td class="paramname"><em>slices</em>, </td>
  297. </tr>
  298. <tr>
  299. <td class="paramkey"></td>
  300. <td></td>
  301. <td class="paramtype">size_t&#160;</td>
  302. <td class="paramname"><em>nslices</em>&#160;</td>
  303. </tr>
  304. <tr>
  305. <td></td>
  306. <td>)</td>
  307. <td></td><td></td>
  308. </tr>
  309. </table>
  310. </div><div class="memdoc">
  311. <p>Returns a RAW byte buffer instance over the given slices (up to <em>nslices</em>). </p>
  312. <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>
  313. </div>
  314. </div>
  315. <a class="anchor" id="ac7407c6fa60073adb166ca4f3cfbc8e7"></a>
  316. <div class="memitem">
  317. <div class="memproto">
  318. <table class="memname">
  319. <tr>
  320. <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>
  321. <td>(</td>
  322. <td class="paramtype"><a class="el" href="structgrpc__byte__buffer__reader.html">grpc_byte_buffer_reader</a> *&#160;</td>
  323. <td class="paramname"><em>reader</em></td><td>)</td>
  324. <td></td>
  325. </tr>
  326. </table>
  327. </div><div class="memdoc">
  328. <p>Returns a RAW byte buffer instance from the output of <em>reader</em>. </p>
  329. </div>
  330. </div>
  331. <a class="anchor" id="a49ca36baa74fa2f9ae0c615bf53cec7d"></a>
  332. <div class="memitem">
  333. <div class="memproto">
  334. <table class="memname">
  335. <tr>
  336. <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>
  337. <td>(</td>
  338. <td class="paramtype"><a class="el" href="structgrpc__slice.html">grpc_slice</a> *&#160;</td>
  339. <td class="paramname"><em>slices</em>, </td>
  340. </tr>
  341. <tr>
  342. <td class="paramkey"></td>
  343. <td></td>
  344. <td class="paramtype">size_t&#160;</td>
  345. <td class="paramname"><em>nslices</em>, </td>
  346. </tr>
  347. <tr>
  348. <td class="paramkey"></td>
  349. <td></td>
  350. <td class="paramtype"><a class="el" href="compression__types_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a>&#160;</td>
  351. <td class="paramname"><em>compression</em>&#160;</td>
  352. </tr>
  353. <tr>
  354. <td></td>
  355. <td>)</td>
  356. <td></td><td></td>
  357. </tr>
  358. </table>
  359. </div><div class="memdoc">
  360. <p>Returns a <em>compressed</em> RAW byte buffer instance over the given slices (up to <em>nslices</em>). </p>
  361. <p>The <em>compression</em> argument defines the compression algorithm used to generate the data in <em>slices</em>.</p>
  362. <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>
  363. </div>
  364. </div>
  365. </div><!-- contents -->
  366. <!-- start footer part -->
  367. <hr class="footer"/><address class="footer"><small>
  368. Generated on Wed Jun 21 2017 14:13:07 for GRPC Core by &#160;<a href="http://www.doxygen.org/index.html">
  369. <img class="footer" src="doxygen.png" alt="doxygen"/>
  370. </a> 1.8.6
  371. </small></address>
  372. </body>
  373. </html>