carto
/
grpc


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GRPC C++: include/grpc/impl/codegen/byte_buffer.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">GRPC C++
   &#160;<span id="projectnumber">1.36.1</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<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>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">byte_buffer.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<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 />
<code>#include &lt;<a class="el" href="grpc__types_8h_source.html">grpc/impl/codegen/grpc_types.h</a>&gt;</code><br />
</div>
<p><a href="grpc_2impl_2codegen_2byte__buffer_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<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>
<tr class="separator:a16143f22ea46cc7fa6b53e6cb30715f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<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="grpc_2impl_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>
<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="grpc_2impl_2codegen_2byte__buffer_8h.html#a5ab72d6615ee89c975c46ad4e50c1387">More...</a><br /></td></tr>
<tr class="separator:a5ab72d6615ee89c975c46ad4e50c1387"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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="grpc_2impl_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>
<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="grpc_2impl_2codegen_2byte__buffer_8h.html#a49ca36baa74fa2f9ae0c615bf53cec7d">More...</a><br /></td></tr>
<tr class="separator:a49ca36baa74fa2f9ae0c615bf53cec7d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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="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>
<tr class="memdesc:a4ebb8f0714bee2c84fed0be62d0dc259"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copies input byte buffer <em>bb</em>.  <a href="grpc_2impl_2codegen_2byte__buffer_8h.html#a4ebb8f0714bee2c84fed0be62d0dc259">More...</a><br /></td></tr>
<tr class="separator:a4ebb8f0714bee2c84fed0be62d0dc259"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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="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>
<tr class="memdesc:a9532c0f54de763057e185a950368b0bb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the size of the given byte buffer, in bytes.  <a href="grpc_2impl_2codegen_2byte__buffer_8h.html#a9532c0f54de763057e185a950368b0bb">More...</a><br /></td></tr>
<tr class="separator:a9532c0f54de763057e185a950368b0bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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="grpc_2impl_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>
<tr class="memdesc:a47fe4b430c9cc3e7c45b59a4cff37b6e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroys <em>byte_buffer</em> deallocating all its memory.  <a href="grpc_2impl_2codegen_2byte__buffer_8h.html#a47fe4b430c9cc3e7c45b59a4cff37b6e">More...</a><br /></td></tr>
<tr class="separator:a47fe4b430c9cc3e7c45b59a4cff37b6e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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="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>
<tr class="memdesc:affd8fb29176a60c44fe704983fa87406"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize <em>reader</em> to read over <em>buffer</em>.  <a href="grpc_2impl_2codegen_2byte__buffer_8h.html#affd8fb29176a60c44fe704983fa87406">More...</a><br /></td></tr>
<tr class="separator:affd8fb29176a60c44fe704983fa87406"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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="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>
<tr class="memdesc:ae28a4ce16b0d8ddd506f1df3fcb3c619"><td class="mdescLeft">&#160;</td><td class="mdescRight">Cleanup and destroy <em>reader</em>.  <a href="grpc_2impl_2codegen_2byte__buffer_8h.html#ae28a4ce16b0d8ddd506f1df3fcb3c619">More...</a><br /></td></tr>
<tr class="separator:ae28a4ce16b0d8ddd506f1df3fcb3c619"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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="grpc_2impl_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>
<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="grpc_2impl_2codegen_2byte__buffer_8h.html#a8352c7f73cf930c8195e547bd1a5a242">More...</a><br /></td></tr>
<tr class="separator:a8352c7f73cf930c8195e547bd1a5a242"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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="grpc_2impl_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>
<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="grpc_2impl_2codegen_2byte__buffer_8h.html#a52e8989121500cd583bd25ca9f3ff359">More...</a><br /></td></tr>
<tr class="separator:a52e8989121500cd583bd25ca9f3ff359"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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="grpc_2impl_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>
<tr class="memdesc:a4cbf1eb762ea3c6c08bcfc46201c7691"><td class="mdescLeft">&#160;</td><td class="mdescRight">Merge all data from <em>reader</em> into single slice.  <a href="grpc_2impl_2codegen_2byte__buffer_8h.html#a4cbf1eb762ea3c6c08bcfc46201c7691">More...</a><br /></td></tr>
<tr class="separator:a4cbf1eb762ea3c6c08bcfc46201c7691"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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="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>
<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="grpc_2impl_2codegen_2byte__buffer_8h.html#ac7407c6fa60073adb166ca4f3cfbc8e7">More...</a><br /></td></tr>
<tr class="separator:ac7407c6fa60073adb166ca4f3cfbc8e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="a16143f22ea46cc7fa6b53e6cb30715f1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a16143f22ea46cc7fa6b53e6cb30715f1">&#9670;&nbsp;</a></span>grpc_byte_buffer_reader</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <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>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a4ebb8f0714bee2c84fed0be62d0dc259"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4ebb8f0714bee2c84fed0be62d0dc259">&#9670;&nbsp;</a></span>grpc_byte_buffer_copy()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <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>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structgrpc__byte__buffer.html">grpc_byte_buffer</a> *&#160;</td>
          <td class="paramname"><em>bb</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Copies input byte buffer <em>bb</em>. </p>
<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>

</div>
</div>
<a id="a47fe4b430c9cc3e7c45b59a4cff37b6e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a47fe4b430c9cc3e7c45b59a4cff37b6e">&#9670;&nbsp;</a></span>grpc_byte_buffer_destroy()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> void grpc_byte_buffer_destroy </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structgrpc__byte__buffer.html">grpc_byte_buffer</a> *&#160;</td>
          <td class="paramname"><em>bb</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Destroys <em>byte_buffer</em> deallocating all its memory. </p>

</div>
</div>
<a id="a9532c0f54de763057e185a950368b0bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9532c0f54de763057e185a950368b0bb">&#9670;&nbsp;</a></span>grpc_byte_buffer_length()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> size_t grpc_byte_buffer_length </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structgrpc__byte__buffer.html">grpc_byte_buffer</a> *&#160;</td>
          <td class="paramname"><em>bb</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the size of the given byte buffer, in bytes. </p>

</div>
</div>
<a id="ae28a4ce16b0d8ddd506f1df3fcb3c619"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae28a4ce16b0d8ddd506f1df3fcb3c619">&#9670;&nbsp;</a></span>grpc_byte_buffer_reader_destroy()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> void grpc_byte_buffer_reader_destroy </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structgrpc__byte__buffer__reader.html">grpc_byte_buffer_reader</a> *&#160;</td>
          <td class="paramname"><em>reader</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Cleanup and destroy <em>reader</em>. </p>

</div>
</div>
<a id="affd8fb29176a60c44fe704983fa87406"></a>
<h2 class="memtitle"><span class="permalink"><a href="#affd8fb29176a60c44fe704983fa87406">&#9670;&nbsp;</a></span>grpc_byte_buffer_reader_init()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> int grpc_byte_buffer_reader_init </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structgrpc__byte__buffer__reader.html">grpc_byte_buffer_reader</a> *&#160;</td>
          <td class="paramname"><em>reader</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structgrpc__byte__buffer.html">grpc_byte_buffer</a> *&#160;</td>
          <td class="paramname"><em>buffer</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Initialize <em>reader</em> to read over <em>buffer</em>. </p>
<p>Returns 1 upon success, 0 otherwise. </p>

</div>
</div>
<a id="a8352c7f73cf930c8195e547bd1a5a242"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8352c7f73cf930c8195e547bd1a5a242">&#9670;&nbsp;</a></span>grpc_byte_buffer_reader_next()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> int grpc_byte_buffer_reader_next </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structgrpc__byte__buffer__reader.html">grpc_byte_buffer_reader</a> *&#160;</td>
          <td class="paramname"><em>reader</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structgrpc__slice.html">grpc_slice</a> *&#160;</td>
          <td class="paramname"><em>slice</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Updates <em>slice</em> with the next piece of data from from <em>reader</em> and returns. </p>
<ol type="1">
<li>Returns 0 at the end of the stream. Caller is responsible for calling grpc_slice_unref on the result. </li>
</ol>

</div>
</div>
<a id="a52e8989121500cd583bd25ca9f3ff359"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a52e8989121500cd583bd25ca9f3ff359">&#9670;&nbsp;</a></span>grpc_byte_buffer_reader_peek()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> int grpc_byte_buffer_reader_peek </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structgrpc__byte__buffer__reader.html">grpc_byte_buffer_reader</a> *&#160;</td>
          <td class="paramname"><em>reader</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structgrpc__slice.html">grpc_slice</a> **&#160;</td>
          <td class="paramname"><em>slice</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>EXPERIMENTAL API - This function may be removed and changed, in the future. </p>
<p>Updates <em>slice</em> with the next piece of data from from <em>reader</em> and returns</p><ol type="1">
<li>Returns 0 at the end of the stream. Caller is responsible for making sure the slice pointer remains valid when accessed.</li>
</ol>
<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>

</div>
</div>
<a id="a4cbf1eb762ea3c6c08bcfc46201c7691"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4cbf1eb762ea3c6c08bcfc46201c7691">&#9670;&nbsp;</a></span>grpc_byte_buffer_reader_readall()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <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>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structgrpc__byte__buffer__reader.html">grpc_byte_buffer_reader</a> *&#160;</td>
          <td class="paramname"><em>reader</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Merge all data from <em>reader</em> into single slice. </p>

</div>
</div>
<a id="a5ab72d6615ee89c975c46ad4e50c1387"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5ab72d6615ee89c975c46ad4e50c1387">&#9670;&nbsp;</a></span>grpc_raw_byte_buffer_create()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <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>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structgrpc__slice.html">grpc_slice</a> *&#160;</td>
          <td class="paramname"><em>slices</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>nslices</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns a RAW byte buffer instance over the given slices (up to <em>nslices</em>). </p>
<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>

</div>
</div>
<a id="ac7407c6fa60073adb166ca4f3cfbc8e7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac7407c6fa60073adb166ca4f3cfbc8e7">&#9670;&nbsp;</a></span>grpc_raw_byte_buffer_from_reader()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <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>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structgrpc__byte__buffer__reader.html">grpc_byte_buffer_reader</a> *&#160;</td>
          <td class="paramname"><em>reader</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns a RAW byte buffer instance from the output of <em>reader</em>. </p>

</div>
</div>
<a id="a49ca36baa74fa2f9ae0c615bf53cec7d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a49ca36baa74fa2f9ae0c615bf53cec7d">&#9670;&nbsp;</a></span>grpc_raw_compressed_byte_buffer_create()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <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>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structgrpc__slice.html">grpc_slice</a> *&#160;</td>
          <td class="paramname"><em>slices</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>nslices</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="compression__types_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a>&#160;</td>
          <td class="paramname"><em>compression</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns a <em>compressed</em> RAW byte buffer instance over the given slices (up to <em>nslices</em>). </p>
<p>The <em>compression</em> argument defines the compression algorithm used to generate the data in <em>slices</em>.</p>
<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>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Mar 3 2021 19:17:21 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>