structgrpc__slice__buffer.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.13"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>GRPC Core: grpc_slice_buffer Struct 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">6.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.13 -->
  34. <script type="text/javascript">
  35. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  36. </script>
  37. <script type="text/javascript" src="menudata.js"></script>
  38. <script type="text/javascript" src="menu.js"></script>
  39. <script type="text/javascript">
  40. $(function() {
  41. initMenu('',true,false,'search.php','Search');
  42. $(document).ready(function() { init_search(); });
  43. });
  44. </script>
  45. <div id="main-nav"></div>
  46. <!-- window showing the filter options -->
  47. <div id="MSearchSelectWindow"
  48. onmouseover="return searchBox.OnSearchSelectShow()"
  49. onmouseout="return searchBox.OnSearchSelectHide()"
  50. onkeydown="return searchBox.OnSearchSelectKey(event)">
  51. </div>
  52. <!-- iframe showing the search results (closed by default) -->
  53. <div id="MSearchResultsWindow">
  54. <iframe src="javascript:void(0)" frameborder="0"
  55. name="MSearchResults" id="MSearchResults">
  56. </iframe>
  57. </div>
  58. </div><!-- top -->
  59. <div class="header">
  60. <div class="summary">
  61. <a href="#pub-attribs">Data Fields</a> </div>
  62. <div class="headertitle">
  63. <div class="title">grpc_slice_buffer Struct Reference</div> </div>
  64. </div><!--header-->
  65. <div class="contents">
  66. <p>Represents an expandable array of slices, to be interpreted as a single item.
  67. <a href="structgrpc__slice__buffer.html#details">More...</a></p>
  68. <p><code>#include &lt;<a class="el" href="impl_2codegen_2slice_8h_source.html">slice.h</a>&gt;</code></p>
  69. <table class="memberdecls">
  70. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  71. Data Fields</h2></td></tr>
  72. <tr class="memitem:a52a8e83b31006d685d98ce4db16520d8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structgrpc__slice.html">grpc_slice</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__slice__buffer.html#a52a8e83b31006d685d98ce4db16520d8">base_slices</a></td></tr>
  73. <tr class="memdesc:a52a8e83b31006d685d98ce4db16520d8"><td class="mdescLeft">&#160;</td><td class="mdescRight">This is for internal use only. <a href="#a52a8e83b31006d685d98ce4db16520d8">More...</a><br /></td></tr>
  74. <tr class="separator:a52a8e83b31006d685d98ce4db16520d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  75. <tr class="memitem:ac37e9d19ec31eab8f429d2b4af908256"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structgrpc__slice.html">grpc_slice</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__slice__buffer.html#ac37e9d19ec31eab8f429d2b4af908256">slices</a></td></tr>
  76. <tr class="memdesc:ac37e9d19ec31eab8f429d2b4af908256"><td class="mdescLeft">&#160;</td><td class="mdescRight">slices in the array (Points to the first valid <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> in the array) <a href="#ac37e9d19ec31eab8f429d2b4af908256">More...</a><br /></td></tr>
  77. <tr class="separator:ac37e9d19ec31eab8f429d2b4af908256"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. <tr class="memitem:ac6b9b99f100ac02280fe6ba0edc754cc"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__slice__buffer.html#ac6b9b99f100ac02280fe6ba0edc754cc">count</a></td></tr>
  79. <tr class="memdesc:ac6b9b99f100ac02280fe6ba0edc754cc"><td class="mdescLeft">&#160;</td><td class="mdescRight">the number of slices in the array <a href="#ac6b9b99f100ac02280fe6ba0edc754cc">More...</a><br /></td></tr>
  80. <tr class="separator:ac6b9b99f100ac02280fe6ba0edc754cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:a8f35fa07c9a4d9f9a4e088a1155e5833"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__slice__buffer.html#a8f35fa07c9a4d9f9a4e088a1155e5833">capacity</a></td></tr>
  82. <tr class="memdesc:a8f35fa07c9a4d9f9a4e088a1155e5833"><td class="mdescLeft">&#160;</td><td class="mdescRight">the number of slices allocated in the array. <a href="#a8f35fa07c9a4d9f9a4e088a1155e5833">More...</a><br /></td></tr>
  83. <tr class="separator:a8f35fa07c9a4d9f9a4e088a1155e5833"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:ad796dcdd16fbb680a7a5368228d20127"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__slice__buffer.html#ad796dcdd16fbb680a7a5368228d20127">length</a></td></tr>
  85. <tr class="memdesc:ad796dcdd16fbb680a7a5368228d20127"><td class="mdescLeft">&#160;</td><td class="mdescRight">the combined length of all slices in the array <a href="#ad796dcdd16fbb680a7a5368228d20127">More...</a><br /></td></tr>
  86. <tr class="separator:ad796dcdd16fbb680a7a5368228d20127"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="memitem:a27c76a4e972a41ab5ac6504c4426fab9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structgrpc__slice.html">grpc_slice</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__slice__buffer.html#a27c76a4e972a41ab5ac6504c4426fab9">inlined</a> [8]</td></tr>
  88. <tr class="memdesc:a27c76a4e972a41ab5ac6504c4426fab9"><td class="mdescLeft">&#160;</td><td class="mdescRight">inlined elements to avoid allocations <a href="#a27c76a4e972a41ab5ac6504c4426fab9">More...</a><br /></td></tr>
  89. <tr class="separator:a27c76a4e972a41ab5ac6504c4426fab9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. </table>
  91. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  92. <div class="textblock"><p>Represents an expandable array of slices, to be interpreted as a single item. </p>
  93. </div><h2 class="groupheader">Field Documentation</h2>
  94. <a id="a52a8e83b31006d685d98ce4db16520d8"></a>
  95. <h2 class="memtitle"><span class="permalink"><a href="#a52a8e83b31006d685d98ce4db16520d8">&#9670;&nbsp;</a></span>base_slices</h2>
  96. <div class="memitem">
  97. <div class="memproto">
  98. <table class="memname">
  99. <tr>
  100. <td class="memname"><a class="el" href="structgrpc__slice.html">grpc_slice</a>* grpc_slice_buffer::base_slices</td>
  101. </tr>
  102. </table>
  103. </div><div class="memdoc">
  104. <p>This is for internal use only. </p>
  105. <p>External users (i.e any code outside grpc core) MUST NOT use this field </p>
  106. </div>
  107. </div>
  108. <a id="a8f35fa07c9a4d9f9a4e088a1155e5833"></a>
  109. <h2 class="memtitle"><span class="permalink"><a href="#a8f35fa07c9a4d9f9a4e088a1155e5833">&#9670;&nbsp;</a></span>capacity</h2>
  110. <div class="memitem">
  111. <div class="memproto">
  112. <table class="memname">
  113. <tr>
  114. <td class="memname">size_t grpc_slice_buffer::capacity</td>
  115. </tr>
  116. </table>
  117. </div><div class="memdoc">
  118. <p>the number of slices allocated in the array. </p>
  119. <p>External users (i.e any code outside grpc core) MUST NOT use this field </p>
  120. </div>
  121. </div>
  122. <a id="ac6b9b99f100ac02280fe6ba0edc754cc"></a>
  123. <h2 class="memtitle"><span class="permalink"><a href="#ac6b9b99f100ac02280fe6ba0edc754cc">&#9670;&nbsp;</a></span>count</h2>
  124. <div class="memitem">
  125. <div class="memproto">
  126. <table class="memname">
  127. <tr>
  128. <td class="memname">size_t grpc_slice_buffer::count</td>
  129. </tr>
  130. </table>
  131. </div><div class="memdoc">
  132. <p>the number of slices in the array </p>
  133. </div>
  134. </div>
  135. <a id="a27c76a4e972a41ab5ac6504c4426fab9"></a>
  136. <h2 class="memtitle"><span class="permalink"><a href="#a27c76a4e972a41ab5ac6504c4426fab9">&#9670;&nbsp;</a></span>inlined</h2>
  137. <div class="memitem">
  138. <div class="memproto">
  139. <table class="memname">
  140. <tr>
  141. <td class="memname"><a class="el" href="structgrpc__slice.html">grpc_slice</a> grpc_slice_buffer::inlined[8]</td>
  142. </tr>
  143. </table>
  144. </div><div class="memdoc">
  145. <p>inlined elements to avoid allocations </p>
  146. </div>
  147. </div>
  148. <a id="ad796dcdd16fbb680a7a5368228d20127"></a>
  149. <h2 class="memtitle"><span class="permalink"><a href="#ad796dcdd16fbb680a7a5368228d20127">&#9670;&nbsp;</a></span>length</h2>
  150. <div class="memitem">
  151. <div class="memproto">
  152. <table class="memname">
  153. <tr>
  154. <td class="memname">size_t grpc_slice_buffer::length</td>
  155. </tr>
  156. </table>
  157. </div><div class="memdoc">
  158. <p>the combined length of all slices in the array </p>
  159. </div>
  160. </div>
  161. <a id="ac37e9d19ec31eab8f429d2b4af908256"></a>
  162. <h2 class="memtitle"><span class="permalink"><a href="#ac37e9d19ec31eab8f429d2b4af908256">&#9670;&nbsp;</a></span>slices</h2>
  163. <div class="memitem">
  164. <div class="memproto">
  165. <table class="memname">
  166. <tr>
  167. <td class="memname"><a class="el" href="structgrpc__slice.html">grpc_slice</a>* grpc_slice_buffer::slices</td>
  168. </tr>
  169. </table>
  170. </div><div class="memdoc">
  171. <p>slices in the array (Points to the first valid <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> in the array) </p>
  172. </div>
  173. </div>
  174. <hr/>The documentation for this struct was generated from the following file:<ul>
  175. <li>include/grpc/impl/codegen/<a class="el" href="impl_2codegen_2slice_8h_source.html">slice.h</a></li>
  176. </ul>
  177. </div><!-- contents -->
  178. <!-- start footer part -->
  179. <hr class="footer"/><address class="footer"><small>
  180. Generated on Fri Apr 13 2018 15:03:52 for GRPC Core by &#160;<a href="http://www.doxygen.org/index.html">
  181. <img class="footer" src="doxygen.png" alt="doxygen"/>
  182. </a> 1.8.13
  183. </small></address>
  184. </body>
  185. </html>