impl_2codegen_2byte__buffer_8h.html 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>GRPC Core: include/grpc/impl/codegen/byte_buffer.h File Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectalign" style="padding-left: 0.5em;">
  24. <div id="projectname">GRPC Core
  25. &#160;<span id="projectnumber">15.0.0</span>
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.8.17 -->
  34. <script type="text/javascript">
  35. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. /* @license-end */
  38. </script>
  39. <script type="text/javascript" src="menudata.js"></script>
  40. <script type="text/javascript" src="menu.js"></script>
  41. <script type="text/javascript">
  42. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  43. $(function() {
  44. initMenu('',true,false,'search.php','Search');
  45. $(document).ready(function() { init_search(); });
  46. });
  47. /* @license-end */</script>
  48. <div id="main-nav"></div>
  49. <!-- window showing the filter options -->
  50. <div id="MSearchSelectWindow"
  51. onmouseover="return searchBox.OnSearchSelectShow()"
  52. onmouseout="return searchBox.OnSearchSelectHide()"
  53. onkeydown="return searchBox.OnSearchSelectKey(event)">
  54. </div>
  55. <!-- iframe showing the search results (closed by default) -->
  56. <div id="MSearchResultsWindow">
  57. <iframe src="javascript:void(0)" frameborder="0"
  58. name="MSearchResults" id="MSearchResults">
  59. </iframe>
  60. </div>
  61. <div id="nav-path" class="navpath">
  62. <ul>
  63. <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>
  64. </div>
  65. </div><!-- top -->
  66. <div class="header">
  67. <div class="summary">
  68. <a href="#typedef-members">Typedefs</a> &#124;
  69. <a href="#func-members">Functions</a> </div>
  70. <div class="headertitle">
  71. <div class="title">byte_buffer.h File Reference</div> </div>
  72. </div><!--header-->
  73. <div class="contents">
  74. <div class="textblock"><code>#include &lt;<a class="el" href="impl_2codegen_2port__platform_8h_source.html">grpc/impl/codegen/port_platform.h</a>&gt;</code><br />
  75. <code>#include &lt;<a class="el" href="grpc__types_8h_source.html">grpc/impl/codegen/grpc_types.h</a>&gt;</code><br />
  76. </div>
  77. <p><a href="impl_2codegen_2byte__buffer_8h_source.html">Go to the source code of this file.</a></p>
  78. <table class="memberdecls">
  79. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
  80. Typedefs</h2></td></tr>
  81. <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>
  82. <tr class="separator:a16143f22ea46cc7fa6b53e6cb30715f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. </table><table class="memberdecls">
  84. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  85. Functions</h2></td></tr>
  86. <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="impl_2codegen_2byte__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>
  87. <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="impl_2codegen_2byte__buffer_8h.html#a5ab72d6615ee89c975c46ad4e50c1387">More...</a><br /></td></tr>
  88. <tr class="separator:a5ab72d6615ee89c975c46ad4e50c1387"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <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="impl_2codegen_2byte__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>
  90. <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="impl_2codegen_2byte__buffer_8h.html#a49ca36baa74fa2f9ae0c615bf53cec7d">More...</a><br /></td></tr>
  91. <tr class="separator:a49ca36baa74fa2f9ae0c615bf53cec7d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <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>
  93. <tr class="memdesc:a4ebb8f0714bee2c84fed0be62d0dc259"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copies input byte buffer <em>bb</em>. <a href="impl_2codegen_2byte__buffer_8h.html#a4ebb8f0714bee2c84fed0be62d0dc259">More...</a><br /></td></tr>
  94. <tr class="separator:a4ebb8f0714bee2c84fed0be62d0dc259"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. <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>
  96. <tr class="memdesc:a9532c0f54de763057e185a950368b0bb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the size of the given byte buffer, in bytes. <a href="impl_2codegen_2byte__buffer_8h.html#a9532c0f54de763057e185a950368b0bb">More...</a><br /></td></tr>
  97. <tr class="separator:a9532c0f54de763057e185a950368b0bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:a47fe4b430c9cc3e7c45b59a4cff37b6e"><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#a47fe4b430c9cc3e7c45b59a4cff37b6e">grpc_byte_buffer_destroy</a> (<a class="el" href="structgrpc__byte__buffer.html">grpc_byte_buffer</a> *bb)</td></tr>
  99. <tr class="memdesc:a47fe4b430c9cc3e7c45b59a4cff37b6e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroys <em>byte_buffer</em> deallocating all its memory. <a href="impl_2codegen_2byte__buffer_8h.html#a47fe4b430c9cc3e7c45b59a4cff37b6e">More...</a><br /></td></tr>
  100. <tr class="separator:a47fe4b430c9cc3e7c45b59a4cff37b6e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <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>
  102. <tr class="memdesc:affd8fb29176a60c44fe704983fa87406"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize <em>reader</em> to read over <em>buffer</em>. <a href="impl_2codegen_2byte__buffer_8h.html#affd8fb29176a60c44fe704983fa87406">More...</a><br /></td></tr>
  103. <tr class="separator:affd8fb29176a60c44fe704983fa87406"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <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>
  105. <tr class="memdesc:ae28a4ce16b0d8ddd506f1df3fcb3c619"><td class="mdescLeft">&#160;</td><td class="mdescRight">Cleanup and destroy <em>reader</em>. <a href="impl_2codegen_2byte__buffer_8h.html#ae28a4ce16b0d8ddd506f1df3fcb3c619">More...</a><br /></td></tr>
  106. <tr class="separator:ae28a4ce16b0d8ddd506f1df3fcb3c619"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <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="impl_2codegen_2byte__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>
  108. <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="impl_2codegen_2byte__buffer_8h.html#a8352c7f73cf930c8195e547bd1a5a242">More...</a><br /></td></tr>
  109. <tr class="separator:a8352c7f73cf930c8195e547bd1a5a242"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="memitem:a52e8989121500cd583bd25ca9f3ff359"><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#a52e8989121500cd583bd25ca9f3ff359">grpc_byte_buffer_reader_peek</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>
  111. <tr class="memdesc:a52e8989121500cd583bd25ca9f3ff359"><td class="mdescLeft">&#160;</td><td class="mdescRight">EXPERIMENTAL API - This function may be removed and changed, in the future. <a href="impl_2codegen_2byte__buffer_8h.html#a52e8989121500cd583bd25ca9f3ff359">More...</a><br /></td></tr>
  112. <tr class="separator:a52e8989121500cd583bd25ca9f3ff359"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <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="impl_2codegen_2byte__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>
  114. <tr class="memdesc:a4cbf1eb762ea3c6c08bcfc46201c7691"><td class="mdescLeft">&#160;</td><td class="mdescRight">Merge all data from <em>reader</em> into single slice. <a href="impl_2codegen_2byte__buffer_8h.html#a4cbf1eb762ea3c6c08bcfc46201c7691">More...</a><br /></td></tr>
  115. <tr class="separator:a4cbf1eb762ea3c6c08bcfc46201c7691"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. <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>
  117. <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="impl_2codegen_2byte__buffer_8h.html#ac7407c6fa60073adb166ca4f3cfbc8e7">More...</a><br /></td></tr>
  118. <tr class="separator:ac7407c6fa60073adb166ca4f3cfbc8e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. </table>
  120. <h2 class="groupheader">Typedef Documentation</h2>
  121. <a id="a16143f22ea46cc7fa6b53e6cb30715f1"></a>
  122. <h2 class="memtitle"><span class="permalink"><a href="#a16143f22ea46cc7fa6b53e6cb30715f1">&#9670;&nbsp;</a></span>grpc_byte_buffer_reader</h2>
  123. <div class="memitem">
  124. <div class="memproto">
  125. <table class="memname">
  126. <tr>
  127. <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>
  128. </tr>
  129. </table>
  130. </div><div class="memdoc">
  131. </div>
  132. </div>
  133. <h2 class="groupheader">Function Documentation</h2>
  134. <a id="a4ebb8f0714bee2c84fed0be62d0dc259"></a>
  135. <h2 class="memtitle"><span class="permalink"><a href="#a4ebb8f0714bee2c84fed0be62d0dc259">&#9670;&nbsp;</a></span>grpc_byte_buffer_copy()</h2>
  136. <div class="memitem">
  137. <div class="memproto">
  138. <table class="memname">
  139. <tr>
  140. <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>
  141. <td>(</td>
  142. <td class="paramtype"><a class="el" href="structgrpc__byte__buffer.html">grpc_byte_buffer</a> *&#160;</td>
  143. <td class="paramname"><em>bb</em></td><td>)</td>
  144. <td></td>
  145. </tr>
  146. </table>
  147. </div><div class="memdoc">
  148. <p>Copies input byte buffer <em>bb</em>. </p>
  149. <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>
  150. </div>
  151. </div>
  152. <a id="a47fe4b430c9cc3e7c45b59a4cff37b6e"></a>
  153. <h2 class="memtitle"><span class="permalink"><a href="#a47fe4b430c9cc3e7c45b59a4cff37b6e">&#9670;&nbsp;</a></span>grpc_byte_buffer_destroy()</h2>
  154. <div class="memitem">
  155. <div class="memproto">
  156. <table class="memname">
  157. <tr>
  158. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> void grpc_byte_buffer_destroy </td>
  159. <td>(</td>
  160. <td class="paramtype"><a class="el" href="structgrpc__byte__buffer.html">grpc_byte_buffer</a> *&#160;</td>
  161. <td class="paramname"><em>bb</em></td><td>)</td>
  162. <td></td>
  163. </tr>
  164. </table>
  165. </div><div class="memdoc">
  166. <p>Destroys <em>byte_buffer</em> deallocating all its memory. </p>
  167. </div>
  168. </div>
  169. <a id="a9532c0f54de763057e185a950368b0bb"></a>
  170. <h2 class="memtitle"><span class="permalink"><a href="#a9532c0f54de763057e185a950368b0bb">&#9670;&nbsp;</a></span>grpc_byte_buffer_length()</h2>
  171. <div class="memitem">
  172. <div class="memproto">
  173. <table class="memname">
  174. <tr>
  175. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> size_t grpc_byte_buffer_length </td>
  176. <td>(</td>
  177. <td class="paramtype"><a class="el" href="structgrpc__byte__buffer.html">grpc_byte_buffer</a> *&#160;</td>
  178. <td class="paramname"><em>bb</em></td><td>)</td>
  179. <td></td>
  180. </tr>
  181. </table>
  182. </div><div class="memdoc">
  183. <p>Returns the size of the given byte buffer, in bytes. </p>
  184. </div>
  185. </div>
  186. <a id="ae28a4ce16b0d8ddd506f1df3fcb3c619"></a>
  187. <h2 class="memtitle"><span class="permalink"><a href="#ae28a4ce16b0d8ddd506f1df3fcb3c619">&#9670;&nbsp;</a></span>grpc_byte_buffer_reader_destroy()</h2>
  188. <div class="memitem">
  189. <div class="memproto">
  190. <table class="memname">
  191. <tr>
  192. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> void grpc_byte_buffer_reader_destroy </td>
  193. <td>(</td>
  194. <td class="paramtype"><a class="el" href="structgrpc__byte__buffer__reader.html">grpc_byte_buffer_reader</a> *&#160;</td>
  195. <td class="paramname"><em>reader</em></td><td>)</td>
  196. <td></td>
  197. </tr>
  198. </table>
  199. </div><div class="memdoc">
  200. <p>Cleanup and destroy <em>reader</em>. </p>
  201. </div>
  202. </div>
  203. <a id="affd8fb29176a60c44fe704983fa87406"></a>
  204. <h2 class="memtitle"><span class="permalink"><a href="#affd8fb29176a60c44fe704983fa87406">&#9670;&nbsp;</a></span>grpc_byte_buffer_reader_init()</h2>
  205. <div class="memitem">
  206. <div class="memproto">
  207. <table class="memname">
  208. <tr>
  209. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> int grpc_byte_buffer_reader_init </td>
  210. <td>(</td>
  211. <td class="paramtype"><a class="el" href="structgrpc__byte__buffer__reader.html">grpc_byte_buffer_reader</a> *&#160;</td>
  212. <td class="paramname"><em>reader</em>, </td>
  213. </tr>
  214. <tr>
  215. <td class="paramkey"></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>buffer</em>&#160;</td>
  219. </tr>
  220. <tr>
  221. <td></td>
  222. <td>)</td>
  223. <td></td><td></td>
  224. </tr>
  225. </table>
  226. </div><div class="memdoc">
  227. <p>Initialize <em>reader</em> to read over <em>buffer</em>. </p>
  228. <p>Returns 1 upon success, 0 otherwise. </p>
  229. </div>
  230. </div>
  231. <a id="a8352c7f73cf930c8195e547bd1a5a242"></a>
  232. <h2 class="memtitle"><span class="permalink"><a href="#a8352c7f73cf930c8195e547bd1a5a242">&#9670;&nbsp;</a></span>grpc_byte_buffer_reader_next()</h2>
  233. <div class="memitem">
  234. <div class="memproto">
  235. <table class="memname">
  236. <tr>
  237. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> int grpc_byte_buffer_reader_next </td>
  238. <td>(</td>
  239. <td class="paramtype"><a class="el" href="structgrpc__byte__buffer__reader.html">grpc_byte_buffer_reader</a> *&#160;</td>
  240. <td class="paramname"><em>reader</em>, </td>
  241. </tr>
  242. <tr>
  243. <td class="paramkey"></td>
  244. <td></td>
  245. <td class="paramtype"><a class="el" href="structgrpc__slice.html">grpc_slice</a> *&#160;</td>
  246. <td class="paramname"><em>slice</em>&#160;</td>
  247. </tr>
  248. <tr>
  249. <td></td>
  250. <td>)</td>
  251. <td></td><td></td>
  252. </tr>
  253. </table>
  254. </div><div class="memdoc">
  255. <p>Updates <em>slice</em> with the next piece of data from from <em>reader</em> and returns. </p>
  256. <ol type="1">
  257. <li>Returns 0 at the end of the stream. Caller is responsible for calling grpc_slice_unref on the result. </li>
  258. </ol>
  259. </div>
  260. </div>
  261. <a id="a52e8989121500cd583bd25ca9f3ff359"></a>
  262. <h2 class="memtitle"><span class="permalink"><a href="#a52e8989121500cd583bd25ca9f3ff359">&#9670;&nbsp;</a></span>grpc_byte_buffer_reader_peek()</h2>
  263. <div class="memitem">
  264. <div class="memproto">
  265. <table class="memname">
  266. <tr>
  267. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> int grpc_byte_buffer_reader_peek </td>
  268. <td>(</td>
  269. <td class="paramtype"><a class="el" href="structgrpc__byte__buffer__reader.html">grpc_byte_buffer_reader</a> *&#160;</td>
  270. <td class="paramname"><em>reader</em>, </td>
  271. </tr>
  272. <tr>
  273. <td class="paramkey"></td>
  274. <td></td>
  275. <td class="paramtype"><a class="el" href="structgrpc__slice.html">grpc_slice</a> **&#160;</td>
  276. <td class="paramname"><em>slice</em>&#160;</td>
  277. </tr>
  278. <tr>
  279. <td></td>
  280. <td>)</td>
  281. <td></td><td></td>
  282. </tr>
  283. </table>
  284. </div><div class="memdoc">
  285. <p>EXPERIMENTAL API - This function may be removed and changed, in the future. </p>
  286. <p>Updates <em>slice</em> with the next piece of data from from <em>reader</em> and returns</p><ol type="1">
  287. <li>Returns 0 at the end of the stream. Caller is responsible for making sure the slice pointer remains valid when accessed.</li>
  288. </ol>
  289. <p>NOTE: Do not use this function unless the caller can guarantee that the underlying <a class="el" href="structgrpc__byte__buffer.html">grpc_byte_buffer</a> outlasts the use of the slice. This is only safe when the underlying <a class="el" href="structgrpc__byte__buffer.html">grpc_byte_buffer</a> remains immutable while slice is being accessed. </p>
  290. </div>
  291. </div>
  292. <a id="a4cbf1eb762ea3c6c08bcfc46201c7691"></a>
  293. <h2 class="memtitle"><span class="permalink"><a href="#a4cbf1eb762ea3c6c08bcfc46201c7691">&#9670;&nbsp;</a></span>grpc_byte_buffer_reader_readall()</h2>
  294. <div class="memitem">
  295. <div class="memproto">
  296. <table class="memname">
  297. <tr>
  298. <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>
  299. <td>(</td>
  300. <td class="paramtype"><a class="el" href="structgrpc__byte__buffer__reader.html">grpc_byte_buffer_reader</a> *&#160;</td>
  301. <td class="paramname"><em>reader</em></td><td>)</td>
  302. <td></td>
  303. </tr>
  304. </table>
  305. </div><div class="memdoc">
  306. <p>Merge all data from <em>reader</em> into single slice. </p>
  307. </div>
  308. </div>
  309. <a id="a5ab72d6615ee89c975c46ad4e50c1387"></a>
  310. <h2 class="memtitle"><span class="permalink"><a href="#a5ab72d6615ee89c975c46ad4e50c1387">&#9670;&nbsp;</a></span>grpc_raw_byte_buffer_create()</h2>
  311. <div class="memitem">
  312. <div class="memproto">
  313. <table class="memname">
  314. <tr>
  315. <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>
  316. <td>(</td>
  317. <td class="paramtype"><a class="el" href="structgrpc__slice.html">grpc_slice</a> *&#160;</td>
  318. <td class="paramname"><em>slices</em>, </td>
  319. </tr>
  320. <tr>
  321. <td class="paramkey"></td>
  322. <td></td>
  323. <td class="paramtype">size_t&#160;</td>
  324. <td class="paramname"><em>nslices</em>&#160;</td>
  325. </tr>
  326. <tr>
  327. <td></td>
  328. <td>)</td>
  329. <td></td><td></td>
  330. </tr>
  331. </table>
  332. </div><div class="memdoc">
  333. <p>Returns a RAW byte buffer instance over the given slices (up to <em>nslices</em>). </p>
  334. <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>
  335. </div>
  336. </div>
  337. <a id="ac7407c6fa60073adb166ca4f3cfbc8e7"></a>
  338. <h2 class="memtitle"><span class="permalink"><a href="#ac7407c6fa60073adb166ca4f3cfbc8e7">&#9670;&nbsp;</a></span>grpc_raw_byte_buffer_from_reader()</h2>
  339. <div class="memitem">
  340. <div class="memproto">
  341. <table class="memname">
  342. <tr>
  343. <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>
  344. <td>(</td>
  345. <td class="paramtype"><a class="el" href="structgrpc__byte__buffer__reader.html">grpc_byte_buffer_reader</a> *&#160;</td>
  346. <td class="paramname"><em>reader</em></td><td>)</td>
  347. <td></td>
  348. </tr>
  349. </table>
  350. </div><div class="memdoc">
  351. <p>Returns a RAW byte buffer instance from the output of <em>reader</em>. </p>
  352. </div>
  353. </div>
  354. <a id="a49ca36baa74fa2f9ae0c615bf53cec7d"></a>
  355. <h2 class="memtitle"><span class="permalink"><a href="#a49ca36baa74fa2f9ae0c615bf53cec7d">&#9670;&nbsp;</a></span>grpc_raw_compressed_byte_buffer_create()</h2>
  356. <div class="memitem">
  357. <div class="memproto">
  358. <table class="memname">
  359. <tr>
  360. <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>
  361. <td>(</td>
  362. <td class="paramtype"><a class="el" href="structgrpc__slice.html">grpc_slice</a> *&#160;</td>
  363. <td class="paramname"><em>slices</em>, </td>
  364. </tr>
  365. <tr>
  366. <td class="paramkey"></td>
  367. <td></td>
  368. <td class="paramtype">size_t&#160;</td>
  369. <td class="paramname"><em>nslices</em>, </td>
  370. </tr>
  371. <tr>
  372. <td class="paramkey"></td>
  373. <td></td>
  374. <td class="paramtype"><a class="el" href="compression__types_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a>&#160;</td>
  375. <td class="paramname"><em>compression</em>&#160;</td>
  376. </tr>
  377. <tr>
  378. <td></td>
  379. <td>)</td>
  380. <td></td><td></td>
  381. </tr>
  382. </table>
  383. </div><div class="memdoc">
  384. <p>Returns a <em>compressed</em> RAW byte buffer instance over the given slices (up to <em>nslices</em>). </p>
  385. <p>The <em>compression</em> argument defines the compression algorithm used to generate the data in <em>slices</em>.</p>
  386. <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>
  387. </div>
  388. </div>
  389. </div><!-- contents -->
  390. <!-- start footer part -->
  391. <hr class="footer"/><address class="footer"><small>
  392. Generated on Wed Mar 3 2021 19:17:10 for GRPC Core by &#160;<a href="http://www.doxygen.org/index.html">
  393. <img class="footer" src="doxygen.png" alt="doxygen"/>
  394. </a> 1.8.17
  395. </small></address>
  396. </body>
  397. </html>