| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322 | <!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: 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/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    <span id="projectnumber">4.0.0-dev</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 Page</span></a></li>      <li><a href="pages.html"><span>Related Pages</span></a></li>      <li><a href="modules.html"><span>Modules</span></a></li>      <li><a href="annotated.html"><span>Data 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 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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </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_629b4cc7516e55c4afb0cb8a61439852.html">include</a></li><li class="navelem"><a class="el" href="dir_d06caa71145e9b2cbe67b49b6fe69d28.html">grpc</a></li><li class="navelem"><a class="el" href="dir_1ccb85353bf7ad9eb207254c908f6dd2.html">impl</a></li><li class="navelem"><a class="el" href="dir_d4a1038da1ca7a38aa498ecf659a57c8.html">codegen</a></li>  </ul></div></div><!-- top --><div class="header">  <div class="summary"><a href="#nested-classes">Data Structures</a> |<a href="#define-members">Macros</a> |<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 <<a class="el" href="impl_2codegen_2port__platform_8h_source.html">grpc/impl/codegen/port_platform.h</a>></code><br/><code>#include <stddef.h></code><br/><code>#include <<a class="el" href="exec__ctx__fwd_8h_source.html">grpc/impl/codegen/exec_ctx_fwd.h</a>></code><br/><code>#include <<a class="el" href="gpr__slice_8h_source.html">grpc/impl/codegen/gpr_slice.h</a>></code><br/></div><p><a href="impl_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  </td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__slice__refcount__vtable.html">grpc_slice_refcount_vtable</a></td></tr><tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Slice API.  <a href="structgrpc__slice__refcount__vtable.html#details">More...</a><br/></td></tr><tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr><tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__slice__refcount.html">grpc_slice_refcount</a></td></tr><tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Reference count container for <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>.  <a href="structgrpc__slice__refcount.html#details">More...</a><br/></td></tr><tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr><tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__slice.html">grpc_slice</a></td></tr><tr class="memdesc:"><td class="mdescLeft"> </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"> </td></tr><tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </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"> </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"> </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:ae65fc74cb3afbcd3299a1c93f90bae20"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="impl_2codegen_2slice_8h.html#ae65fc74cb3afbcd3299a1c93f90bae20">GRPC_SLICE_INLINED_SIZE</a>   (sizeof(size_t) + sizeof(uint8_t *) - 1)</td></tr><tr class="separator:ae65fc74cb3afbcd3299a1c93f90bae20"><td class="memSeparator" colspan="2"> </td></tr><tr class="memitem:a81db47a2be0a079aa797cd77f3864809"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="impl_2codegen_2slice_8h.html#a81db47a2be0a079aa797cd77f3864809">GRPC_SLICE_BUFFER_INLINE_ELEMENTS</a>   8</td></tr><tr class="separator:a81db47a2be0a079aa797cd77f3864809"><td class="memSeparator" colspan="2"> </td></tr><tr class="memitem:a8a15783c251cdeb18c3f8b0ad41d0352"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="impl_2codegen_2slice_8h.html#a8a15783c251cdeb18c3f8b0ad41d0352">GRPC_SLICE_START_PTR</a>(slice)</td></tr><tr class="separator:a8a15783c251cdeb18c3f8b0ad41d0352"><td class="memSeparator" colspan="2"> </td></tr><tr class="memitem:ae965fb2ee1a646253cdbd49d82b0b6c5"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="impl_2codegen_2slice_8h.html#ae965fb2ee1a646253cdbd49d82b0b6c5">GRPC_SLICE_LENGTH</a>(slice)</td></tr><tr class="separator:ae965fb2ee1a646253cdbd49d82b0b6c5"><td class="memSeparator" colspan="2"> </td></tr><tr class="memitem:a6791fa7be0a1a9144e005cfea7baea84"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="impl_2codegen_2slice_8h.html#a6791fa7be0a1a9144e005cfea7baea84">GRPC_SLICE_SET_LENGTH</a>(slice, newlen)</td></tr><tr class="separator:a6791fa7be0a1a9144e005cfea7baea84"><td class="memSeparator" colspan="2"> </td></tr><tr class="memitem:a96535019e10a540192c1f276ec049a56"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="impl_2codegen_2slice_8h.html#a96535019e10a540192c1f276ec049a56">GRPC_SLICE_END_PTR</a>(slice)   <a class="el" href="impl_2codegen_2slice_8h.html#a8a15783c251cdeb18c3f8b0ad41d0352">GRPC_SLICE_START_PTR</a>(slice) + <a class="el" href="impl_2codegen_2slice_8h.html#ae965fb2ee1a646253cdbd49d82b0b6c5">GRPC_SLICE_LENGTH</a>(slice)</td></tr><tr class="separator:a96535019e10a540192c1f276ec049a56"><td class="memSeparator" colspan="2"> </td></tr><tr class="memitem:a829178b3baec8b96a992a5607ad3ed93"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="impl_2codegen_2slice_8h.html#a829178b3baec8b96a992a5607ad3ed93">GRPC_SLICE_IS_EMPTY</a>(slice)   (<a class="el" href="impl_2codegen_2slice_8h.html#ae965fb2ee1a646253cdbd49d82b0b6c5">GRPC_SLICE_LENGTH</a>(slice) == 0)</td></tr><tr class="separator:a829178b3baec8b96a992a5607ad3ed93"><td class="memSeparator" colspan="2"> </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> </td><td class="memItemRight" valign="bottom"><a class="el" href="impl_2codegen_2slice_8h.html#a2a5f8eaa5d8784bfec46ac983644dca2">grpc_slice</a></td></tr><tr class="separator:a2a5f8eaa5d8784bfec46ac983644dca2"><td class="memSeparator" colspan="2"> </td></tr><tr class="memitem:a0ba9a84b74d6308678a2f53212b5b3fd"><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/><a class="el" href="structgrpc__slice__refcount__vtable.html">grpc_slice_refcount_vtable</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="impl_2codegen_2slice_8h.html#a0ba9a84b74d6308678a2f53212b5b3fd">grpc_slice_refcount_vtable</a></td></tr><tr class="memdesc:a0ba9a84b74d6308678a2f53212b5b3fd"><td class="mdescLeft"> </td><td class="mdescRight">Slice API.  <a href="#a0ba9a84b74d6308678a2f53212b5b3fd">More...</a><br/></td></tr><tr class="separator:a0ba9a84b74d6308678a2f53212b5b3fd"><td class="memSeparator" colspan="2"> </td></tr><tr class="memitem:acb7fc89ea8343fde6d0c09f1ea70dbc4"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structgrpc__slice__refcount.html">grpc_slice_refcount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="impl_2codegen_2slice_8h.html#acb7fc89ea8343fde6d0c09f1ea70dbc4">grpc_slice_refcount</a></td></tr><tr class="memdesc:acb7fc89ea8343fde6d0c09f1ea70dbc4"><td class="mdescLeft"> </td><td class="mdescRight">Reference count container for <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>.  <a href="#acb7fc89ea8343fde6d0c09f1ea70dbc4">More...</a><br/></td></tr><tr class="separator:acb7fc89ea8343fde6d0c09f1ea70dbc4"><td class="memSeparator" colspan="2"> </td></tr></table><h2 class="groupheader">Macro Definition Documentation</h2><a class="anchor" id="a81db47a2be0a079aa797cd77f3864809"></a><div class="memitem"><div class="memproto">      <table class="memname">        <tr>          <td class="memname">#define GRPC_SLICE_BUFFER_INLINE_ELEMENTS   8</td>        </tr>      </table></div><div class="memdoc"></div></div><a class="anchor" id="a96535019e10a540192c1f276ec049a56"></a><div class="memitem"><div class="memproto">      <table class="memname">        <tr>          <td class="memname">#define GRPC_SLICE_END_PTR</td>          <td>(</td>          <td class="paramtype"> </td>          <td class="paramname">slice</td><td>)</td>          <td>   <a class="el" href="impl_2codegen_2slice_8h.html#a8a15783c251cdeb18c3f8b0ad41d0352">GRPC_SLICE_START_PTR</a>(slice) + <a class="el" href="impl_2codegen_2slice_8h.html#ae965fb2ee1a646253cdbd49d82b0b6c5">GRPC_SLICE_LENGTH</a>(slice)</td>        </tr>      </table></div><div class="memdoc"></div></div><a class="anchor" id="ae65fc74cb3afbcd3299a1c93f90bae20"></a><div class="memitem"><div class="memproto">      <table class="memname">        <tr>          <td class="memname">#define GRPC_SLICE_INLINED_SIZE   (sizeof(size_t) + sizeof(uint8_t *) - 1)</td>        </tr>      </table></div><div class="memdoc"></div></div><a class="anchor" id="a829178b3baec8b96a992a5607ad3ed93"></a><div class="memitem"><div class="memproto">      <table class="memname">        <tr>          <td class="memname">#define GRPC_SLICE_IS_EMPTY</td>          <td>(</td>          <td class="paramtype"> </td>          <td class="paramname">slice</td><td>)</td>          <td>   (<a class="el" href="impl_2codegen_2slice_8h.html#ae965fb2ee1a646253cdbd49d82b0b6c5">GRPC_SLICE_LENGTH</a>(slice) == 0)</td>        </tr>      </table></div><div class="memdoc"></div></div><a class="anchor" id="ae965fb2ee1a646253cdbd49d82b0b6c5"></a><div class="memitem"><div class="memproto">      <table class="memname">        <tr>          <td class="memname">#define GRPC_SLICE_LENGTH</td>          <td>(</td>          <td class="paramtype"> </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 class="anchor" id="a6791fa7be0a1a9144e005cfea7baea84"></a><div class="memitem"><div class="memproto">      <table class="memname">        <tr>          <td class="memname">#define GRPC_SLICE_SET_LENGTH</td>          <td>(</td>          <td class="paramtype"> </td>          <td class="paramname">slice, </td>        </tr>        <tr>          <td class="paramkey"></td>          <td></td>          <td class="paramtype"> </td>          <td class="paramname">newlen </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 class="anchor" id="a8a15783c251cdeb18c3f8b0ad41d0352"></a><div class="memitem"><div class="memproto">      <table class="memname">        <tr>          <td class="memname">#define GRPC_SLICE_START_PTR</td>          <td>(</td>          <td class="paramtype"> </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 class="anchor" id="a2a5f8eaa5d8784bfec46ac983644dca2"></a><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 class="anchor" id="acb7fc89ea8343fde6d0c09f1ea70dbc4"></a><div class="memitem"><div class="memproto">      <table class="memname">        <tr>          <td class="memname">typedef struct <a class="el" href="structgrpc__slice__refcount.html">grpc_slice_refcount</a>  <a class="el" href="structgrpc__slice__refcount.html">grpc_slice_refcount</a></td>        </tr>      </table></div><div class="memdoc"><p>Reference count container for <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>. </p><p>Contains function pointers to increment and decrement reference counts. Implementations should cleanup when the reference count drops to zero. Typically client code should not touch this, and use grpc_slice_malloc, grpc_slice_new, or grpc_slice_new_with_len instead. </p></div></div><a class="anchor" id="a0ba9a84b74d6308678a2f53212b5b3fd"></a><div class="memitem"><div class="memproto">      <table class="memname">        <tr>          <td class="memname">typedef struct <a class="el" href="structgrpc__slice__refcount__vtable.html">grpc_slice_refcount_vtable</a>  <a class="el" href="structgrpc__slice__refcount__vtable.html">grpc_slice_refcount_vtable</a></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></div><!-- contents --><!-- start footer part --><hr class="footer"/><address class="footer"><small>Generated on Wed May 31 2017 15:48:57 for GRPC Core by  <a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6</small></address></body></html>
 |