carto
/
grpc


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310
							<!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GRPC C++: include/grpc/impl/codegen/slice.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.23.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</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="#nested-classes">Data Structures</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#typedef-members">Typedefs</a>  </div>
  <div class="headertitle">
<div class="title">slice.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;stddef.h&gt;</code><br />
<code>#include &lt;<a class="el" href="gpr__slice_8h_source.html">grpc/impl/codegen/gpr_slice.h</a>&gt;</code><br />
</div>
<p><a href="grpc_2impl_2codegen_2slice_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="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__slice.html">grpc_slice</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A <a class="el" href="structgrpc__slice.html" title="A grpc_slice s, if initialized, represents the byte range s.bytes[0..s.length-1]. ...">grpc_slice</a> s, if initialized, represents the byte range s.bytes[0..s.length-1].  <a href="structgrpc__slice.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">union &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="uniongrpc__slice_1_1grpc__slice__data.html">grpc_slice::grpc_slice_data</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__slice_1_1grpc__slice__data_1_1grpc__slice__refcounted.html">grpc_slice::grpc_slice_data::grpc_slice_refcounted</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__slice_1_1grpc__slice__data_1_1grpc__slice__inlined.html">grpc_slice::grpc_slice_data::grpc_slice_inlined</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__slice__buffer.html">grpc_slice_buffer</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Represents an expandable array of slices, to be interpreted as a single item.  <a href="structgrpc__slice__buffer.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a6a30245ea694a3915b1413a2f50c9b54"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc_2impl_2codegen_2slice_8h.html#a6a30245ea694a3915b1413a2f50c9b54">GRPC_SLICE_INLINE_EXTRA_SIZE</a>&#160;&#160;&#160;sizeof(void*)</td></tr>
<tr class="memdesc:a6a30245ea694a3915b1413a2f50c9b54"><td class="mdescLeft">&#160;</td><td class="mdescRight">Slice API.  <a href="#a6a30245ea694a3915b1413a2f50c9b54">More...</a><br /></td></tr>
<tr class="separator:a6a30245ea694a3915b1413a2f50c9b54"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae65fc74cb3afbcd3299a1c93f90bae20"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc_2impl_2codegen_2slice_8h.html#ae65fc74cb3afbcd3299a1c93f90bae20">GRPC_SLICE_INLINED_SIZE</a>&#160;&#160;&#160;(sizeof(size_t) + sizeof(uint8_t*) - 1 + <a class="el" href="grpc_2impl_2codegen_2slice_8h.html#a6a30245ea694a3915b1413a2f50c9b54">GRPC_SLICE_INLINE_EXTRA_SIZE</a>)</td></tr>
<tr class="separator:ae65fc74cb3afbcd3299a1c93f90bae20"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a81db47a2be0a079aa797cd77f3864809"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc_2impl_2codegen_2slice_8h.html#a81db47a2be0a079aa797cd77f3864809">GRPC_SLICE_BUFFER_INLINE_ELEMENTS</a>&#160;&#160;&#160;8</td></tr>
<tr class="separator:a81db47a2be0a079aa797cd77f3864809"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8a15783c251cdeb18c3f8b0ad41d0352"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc_2impl_2codegen_2slice_8h.html#a8a15783c251cdeb18c3f8b0ad41d0352">GRPC_SLICE_START_PTR</a>(slice)</td></tr>
<tr class="separator:a8a15783c251cdeb18c3f8b0ad41d0352"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae965fb2ee1a646253cdbd49d82b0b6c5"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc_2impl_2codegen_2slice_8h.html#ae965fb2ee1a646253cdbd49d82b0b6c5">GRPC_SLICE_LENGTH</a>(slice)</td></tr>
<tr class="separator:ae965fb2ee1a646253cdbd49d82b0b6c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6791fa7be0a1a9144e005cfea7baea84"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc_2impl_2codegen_2slice_8h.html#a6791fa7be0a1a9144e005cfea7baea84">GRPC_SLICE_SET_LENGTH</a>(slice,  newlen)</td></tr>
<tr class="separator:a6791fa7be0a1a9144e005cfea7baea84"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a96535019e10a540192c1f276ec049a56"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc_2impl_2codegen_2slice_8h.html#a96535019e10a540192c1f276ec049a56">GRPC_SLICE_END_PTR</a>(slice)&#160;&#160;&#160;<a class="el" href="grpc_2impl_2codegen_2slice_8h.html#a8a15783c251cdeb18c3f8b0ad41d0352">GRPC_SLICE_START_PTR</a>(slice) + <a class="el" href="grpc_2impl_2codegen_2slice_8h.html#ae965fb2ee1a646253cdbd49d82b0b6c5">GRPC_SLICE_LENGTH</a>(slice)</td></tr>
<tr class="separator:a96535019e10a540192c1f276ec049a56"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a829178b3baec8b96a992a5607ad3ed93"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc_2impl_2codegen_2slice_8h.html#a829178b3baec8b96a992a5607ad3ed93">GRPC_SLICE_IS_EMPTY</a>(slice)&#160;&#160;&#160;(<a class="el" href="grpc_2impl_2codegen_2slice_8h.html#ae965fb2ee1a646253cdbd49d82b0b6c5">GRPC_SLICE_LENGTH</a>(slice) == 0)</td></tr>
<tr class="separator:a829178b3baec8b96a992a5607ad3ed93"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a2a5f8eaa5d8784bfec46ac983644dca2"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structgrpc__slice.html">grpc_slice</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc_2impl_2codegen_2slice_8h.html#a2a5f8eaa5d8784bfec46ac983644dca2">grpc_slice</a></td></tr>
<tr class="separator:a2a5f8eaa5d8784bfec46ac983644dca2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a96ab1e43093bbd3fa178ae2e819863e4"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structgrpc__slice__buffer.html">grpc_slice_buffer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc_2impl_2codegen_2slice_8h.html#a96ab1e43093bbd3fa178ae2e819863e4">grpc_slice_buffer</a></td></tr>
<tr class="memdesc:a96ab1e43093bbd3fa178ae2e819863e4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Represents an expandable array of slices, to be interpreted as a single item.  <a href="#a96ab1e43093bbd3fa178ae2e819863e4">More...</a><br /></td></tr>
<tr class="separator:a96ab1e43093bbd3fa178ae2e819863e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a81db47a2be0a079aa797cd77f3864809"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a81db47a2be0a079aa797cd77f3864809">&#9670;&nbsp;</a></span>GRPC_SLICE_BUFFER_INLINE_ELEMENTS</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define GRPC_SLICE_BUFFER_INLINE_ELEMENTS&#160;&#160;&#160;8</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="a96535019e10a540192c1f276ec049a56"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a96535019e10a540192c1f276ec049a56">&#9670;&nbsp;</a></span>GRPC_SLICE_END_PTR</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define GRPC_SLICE_END_PTR</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">slice</td><td>)</td>
          <td>&#160;&#160;&#160;<a class="el" href="grpc_2impl_2codegen_2slice_8h.html#a8a15783c251cdeb18c3f8b0ad41d0352">GRPC_SLICE_START_PTR</a>(slice) + <a class="el" href="grpc_2impl_2codegen_2slice_8h.html#ae965fb2ee1a646253cdbd49d82b0b6c5">GRPC_SLICE_LENGTH</a>(slice)</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="a6a30245ea694a3915b1413a2f50c9b54"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6a30245ea694a3915b1413a2f50c9b54">&#9670;&nbsp;</a></span>GRPC_SLICE_INLINE_EXTRA_SIZE</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define GRPC_SLICE_INLINE_EXTRA_SIZE&#160;&#160;&#160;sizeof(void*)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Slice API. </p>
<p>A slice represents a contiguous reference counted array of bytes. It is cheap to take references to a slice, and it is cheap to create a slice pointing to a subset of another slice.</p>
<p>The data-structure for slices is exposed here to allow non-gpr code to build slices from whatever data they have available.</p>
<p>When defining interfaces that handle slices, care should be taken to define reference ownership semantics (who should call unref?) and mutability constraints (is the callee allowed to modify the slice?) </p>

</div>
</div>
<a id="ae65fc74cb3afbcd3299a1c93f90bae20"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae65fc74cb3afbcd3299a1c93f90bae20">&#9670;&nbsp;</a></span>GRPC_SLICE_INLINED_SIZE</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define GRPC_SLICE_INLINED_SIZE&#160;&#160;&#160;(sizeof(size_t) + sizeof(uint8_t*) - 1 + <a class="el" href="grpc_2impl_2codegen_2slice_8h.html#a6a30245ea694a3915b1413a2f50c9b54">GRPC_SLICE_INLINE_EXTRA_SIZE</a>)</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="a829178b3baec8b96a992a5607ad3ed93"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a829178b3baec8b96a992a5607ad3ed93">&#9670;&nbsp;</a></span>GRPC_SLICE_IS_EMPTY</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define GRPC_SLICE_IS_EMPTY</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">slice</td><td>)</td>
          <td>&#160;&#160;&#160;(<a class="el" href="grpc_2impl_2codegen_2slice_8h.html#ae965fb2ee1a646253cdbd49d82b0b6c5">GRPC_SLICE_LENGTH</a>(slice) == 0)</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="ae965fb2ee1a646253cdbd49d82b0b6c5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae965fb2ee1a646253cdbd49d82b0b6c5">&#9670;&nbsp;</a></span>GRPC_SLICE_LENGTH</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define GRPC_SLICE_LENGTH</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">slice</td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line">((slice).refcount ? (slice).data.refcounted.length \</div><div class="line">                    : (slice).data.inlined.length)</div></div><!-- fragment -->
</div>
</div>
<a id="a6791fa7be0a1a9144e005cfea7baea84"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6791fa7be0a1a9144e005cfea7baea84">&#9670;&nbsp;</a></span>GRPC_SLICE_SET_LENGTH</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define GRPC_SLICE_SET_LENGTH</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">slice, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">newlen&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line">((slice).refcount ? ((slice).data.refcounted.length = (size_t)(newlen)) \</div><div class="line">                    : ((slice).data.inlined.length = (uint8_t)(newlen)))</div></div><!-- fragment -->
</div>
</div>
<a id="a8a15783c251cdeb18c3f8b0ad41d0352"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8a15783c251cdeb18c3f8b0ad41d0352">&#9670;&nbsp;</a></span>GRPC_SLICE_START_PTR</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define GRPC_SLICE_START_PTR</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">slice</td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line">((slice).refcount ? (slice).data.refcounted.bytes \</div><div class="line">                    : (slice).data.inlined.bytes)</div></div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="a2a5f8eaa5d8784bfec46ac983644dca2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2a5f8eaa5d8784bfec46ac983644dca2">&#9670;&nbsp;</a></span>grpc_slice</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef struct <a class="el" href="structgrpc__slice.html">grpc_slice</a> <a class="el" href="structgrpc__slice.html">grpc_slice</a></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="a96ab1e43093bbd3fa178ae2e819863e4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a96ab1e43093bbd3fa178ae2e819863e4">&#9670;&nbsp;</a></span>grpc_slice_buffer</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef struct <a class="el" href="structgrpc__slice__buffer.html">grpc_slice_buffer</a>  <a class="el" href="structgrpc__slice__buffer.html">grpc_slice_buffer</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Represents an expandable array of slices, to be interpreted as a single item. </p>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Aug 19 2019 12:05:23 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>