carto
/
grpc


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.6"/>
<title>GRPC Core: src/core/surface/byte_buffer.c 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/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</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 style="padding-left: 0.5em;">
   <div id="projectname">GRPC Core
   &#160;<span id="projectnumber">0.11.0.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>Globals</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<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>Pages</a></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_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_aebb8dcc11953d78e620bbef0b9e2183.html">core</a></li><li class="navelem"><a class="el" href="dir_ea54cbef5e3ffa125df07262bbfc9627.html">surface</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">byte_buffer.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;<a class="el" href="byte__buffer_8h_source.html">grpc/byte_buffer.h</a>&gt;</code><br/>
<code>#include &lt;<a class="el" href="alloc_8h_source.html">grpc/support/alloc.h</a>&gt;</code><br/>
<code>#include &lt;<a class="el" href="log_8h_source.html">grpc/support/log.h</a>&gt;</code><br/>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a1aaaa0d8a1609166e0b0bb2b42332618"><td class="memItemLeft" align="right" valign="top"><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_8c.html#a1aaaa0d8a1609166e0b0bb2b42332618">grpc_raw_byte_buffer_create</a> (<a class="el" href="structgpr__slice.html">gpr_slice</a> *slices, size_t nslices)</td></tr>
<tr class="memdesc:a1aaaa0d8a1609166e0b0bb2b42332618"><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="#a1aaaa0d8a1609166e0b0bb2b42332618">More...</a><br/></td></tr>
<tr class="separator:a1aaaa0d8a1609166e0b0bb2b42332618"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af9801acc1dbfd02b2c51ed9d504cd12b"><td class="memItemLeft" align="right" valign="top"><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_8c.html#af9801acc1dbfd02b2c51ed9d504cd12b">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_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a> compression)</td></tr>
<tr class="memdesc:af9801acc1dbfd02b2c51ed9d504cd12b"><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="#af9801acc1dbfd02b2c51ed9d504cd12b">More...</a><br/></td></tr>
<tr class="separator:af9801acc1dbfd02b2c51ed9d504cd12b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9b4f877e32f45e0e704970e89582e0df"><td class="memItemLeft" align="right" valign="top"><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_8c.html#a9b4f877e32f45e0e704970e89582e0df">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:a9b4f877e32f45e0e704970e89582e0df"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a RAW byte buffer instance from the output of <em>reader</em>.  <a href="#a9b4f877e32f45e0e704970e89582e0df">More...</a><br/></td></tr>
<tr class="separator:a9b4f877e32f45e0e704970e89582e0df"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aac8a5605c5de93a78da7e8ca06a80efb"><td class="memItemLeft" align="right" valign="top"><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_8c.html#aac8a5605c5de93a78da7e8ca06a80efb">grpc_byte_buffer_copy</a> (<a class="el" href="structgrpc__byte__buffer.html">grpc_byte_buffer</a> *bb)</td></tr>
<tr class="memdesc:aac8a5605c5de93a78da7e8ca06a80efb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copies input byte buffer <em>bb</em>.  <a href="#aac8a5605c5de93a78da7e8ca06a80efb">More...</a><br/></td></tr>
<tr class="separator:aac8a5605c5de93a78da7e8ca06a80efb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0099fc01264d8aeb7cd56dfb58652d22"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="byte__buffer_8c.html#a0099fc01264d8aeb7cd56dfb58652d22">grpc_byte_buffer_destroy</a> (<a class="el" href="structgrpc__byte__buffer.html">grpc_byte_buffer</a> *bb)</td></tr>
<tr class="memdesc:a0099fc01264d8aeb7cd56dfb58652d22"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroys <em>byte_buffer</em> deallocating all its memory.  <a href="#a0099fc01264d8aeb7cd56dfb58652d22">More...</a><br/></td></tr>
<tr class="separator:a0099fc01264d8aeb7cd56dfb58652d22"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a61b6ac03d6a50664786e45d616ba435d"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="byte__buffer_8c.html#a61b6ac03d6a50664786e45d616ba435d">grpc_byte_buffer_length</a> (<a class="el" href="structgrpc__byte__buffer.html">grpc_byte_buffer</a> *bb)</td></tr>
<tr class="memdesc:a61b6ac03d6a50664786e45d616ba435d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the size of the given byte buffer, in bytes.  <a href="#a61b6ac03d6a50664786e45d616ba435d">More...</a><br/></td></tr>
<tr class="separator:a61b6ac03d6a50664786e45d616ba435d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="aac8a5605c5de93a78da7e8ca06a80efb"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><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 class="anchor" id="a0099fc01264d8aeb7cd56dfb58652d22"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">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>byte_buffer</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 class="anchor" id="a61b6ac03d6a50664786e45d616ba435d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">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 class="anchor" id="a1aaaa0d8a1609166e0b0bb2b42332618"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><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="structgpr__slice.html">gpr_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 class="anchor" id="a9b4f877e32f45e0e704970e89582e0df"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><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 class="anchor" id="af9801acc1dbfd02b2c51ed9d504cd12b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><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="structgpr__slice.html">gpr_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_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 Thu Sep 3 2015 09:44:13 for GRPC Core by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>