classgrpc_1_1internal_1_1_grpc_buffer_reader.html 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419
  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 C++: grpc::internal::GrpcBufferReader Class 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 C++
  25. &#160;<span id="projectnumber">1.11.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 id="nav-path" class="navpath">
  59. <ul>
  60. <li class="navelem"><a class="el" href="namespacegrpc.html">grpc</a></li><li class="navelem"><a class="el" href="namespacegrpc_1_1internal.html">internal</a></li><li class="navelem"><a class="el" href="classgrpc_1_1internal_1_1_grpc_buffer_reader.html">GrpcBufferReader</a></li> </ul>
  61. </div>
  62. </div><!-- top -->
  63. <div class="header">
  64. <div class="summary">
  65. <a href="#pub-methods">Public Member Functions</a> &#124;
  66. <a href="#pro-attribs">Protected Attributes</a> </div>
  67. <div class="headertitle">
  68. <div class="title">grpc::internal::GrpcBufferReader Class Reference</div> </div>
  69. </div><!--header-->
  70. <div class="contents">
  71. <p><code>#include &lt;<a class="el" href="grpcpp_2impl_2codegen_2proto__utils_8h_source.html">proto_utils.h</a>&gt;</code></p>
  72. <table class="memberdecls">
  73. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  74. Public Member Functions</h2></td></tr>
  75. <tr class="memitem:a17568350c9ee6a89e0a901cfff8401f6"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_grpc_buffer_reader.html#a17568350c9ee6a89e0a901cfff8401f6">GrpcBufferReader</a> (<a class="el" href="structgrpc__byte__buffer.html">grpc_byte_buffer</a> *buffer)</td></tr>
  76. <tr class="separator:a17568350c9ee6a89e0a901cfff8401f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77. <tr class="memitem:a5b8f11869c456df354a87dabfaec97f1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_grpc_buffer_reader.html#a5b8f11869c456df354a87dabfaec97f1">~GrpcBufferReader</a> () override</td></tr>
  78. <tr class="separator:a5b8f11869c456df354a87dabfaec97f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  79. <tr class="memitem:ae66351a9aa970bdb225bbba45f279bb2"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_grpc_buffer_reader.html#ae66351a9aa970bdb225bbba45f279bb2">Next</a> (const void **data, int *size) override</td></tr>
  80. <tr class="separator:ae66351a9aa970bdb225bbba45f279bb2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:a34cf482f798ff91efce00096851f787b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_grpc_buffer_reader.html#a34cf482f798ff91efce00096851f787b">status</a> () const</td></tr>
  82. <tr class="separator:a34cf482f798ff91efce00096851f787b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="memitem:a724c133b537616eee22562b3e89885c8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_grpc_buffer_reader.html#a724c133b537616eee22562b3e89885c8">BackUp</a> (int count) override</td></tr>
  84. <tr class="separator:a724c133b537616eee22562b3e89885c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr class="memitem:a7aad5fe555993d8f86380e3b4c65db1c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_grpc_buffer_reader.html#a7aad5fe555993d8f86380e3b4c65db1c">Skip</a> (int count) override</td></tr>
  86. <tr class="separator:a7aad5fe555993d8f86380e3b4c65db1c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="memitem:acc660ae3172f370d7d2538f9fb9067b1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacegrpc_1_1protobuf.html#ad614bff24fe4674ca81af74c769a7b32">grpc::protobuf::int64</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_grpc_buffer_reader.html#acc660ae3172f370d7d2538f9fb9067b1">ByteCount</a> () const override</td></tr>
  88. <tr class="separator:acc660ae3172f370d7d2538f9fb9067b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. </table><table class="memberdecls">
  90. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
  91. Protected Attributes</h2></td></tr>
  92. <tr class="memitem:a0a6a65ef8eb5b5bb3d39a7b935ba78ab"><td class="memItemLeft" align="right" valign="top">int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_grpc_buffer_reader.html#a0a6a65ef8eb5b5bb3d39a7b935ba78ab">byte_count_</a></td></tr>
  93. <tr class="separator:a0a6a65ef8eb5b5bb3d39a7b935ba78ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:a1ea14debdd9fb96f8f94e755aea5904c"><td class="memItemLeft" align="right" valign="top">int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_grpc_buffer_reader.html#a1ea14debdd9fb96f8f94e755aea5904c">backup_count_</a></td></tr>
  95. <tr class="separator:a1ea14debdd9fb96f8f94e755aea5904c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:a52aae88ebfa452907a74625af1e2975e"><td class="memItemLeft" align="right" valign="top"><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="classgrpc_1_1internal_1_1_grpc_buffer_reader.html#a52aae88ebfa452907a74625af1e2975e">reader_</a></td></tr>
  97. <tr class="separator:a52aae88ebfa452907a74625af1e2975e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:a74845b264add2937ff253114edb008cb"><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="classgrpc_1_1internal_1_1_grpc_buffer_reader.html#a74845b264add2937ff253114edb008cb">slice_</a></td></tr>
  99. <tr class="separator:a74845b264add2937ff253114edb008cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:a85a798cb005abf72d2bc0a6a04e4bf92"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_grpc_buffer_reader.html#a85a798cb005abf72d2bc0a6a04e4bf92">status_</a></td></tr>
  101. <tr class="separator:a85a798cb005abf72d2bc0a6a04e4bf92"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. </table>
  103. <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  104. <a id="a17568350c9ee6a89e0a901cfff8401f6"></a>
  105. <h2 class="memtitle"><span class="permalink"><a href="#a17568350c9ee6a89e0a901cfff8401f6">&#9670;&nbsp;</a></span>GrpcBufferReader()</h2>
  106. <div class="memitem">
  107. <div class="memproto">
  108. <table class="mlabels">
  109. <tr>
  110. <td class="mlabels-left">
  111. <table class="memname">
  112. <tr>
  113. <td class="memname">grpc::internal::GrpcBufferReader::GrpcBufferReader </td>
  114. <td>(</td>
  115. <td class="paramtype"><a class="el" href="structgrpc__byte__buffer.html">grpc_byte_buffer</a> *&#160;</td>
  116. <td class="paramname"><em>buffer</em></td><td>)</td>
  117. <td></td>
  118. </tr>
  119. </table>
  120. </td>
  121. <td class="mlabels-right">
  122. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
  123. </tr>
  124. </table>
  125. </div><div class="memdoc">
  126. </div>
  127. </div>
  128. <a id="a5b8f11869c456df354a87dabfaec97f1"></a>
  129. <h2 class="memtitle"><span class="permalink"><a href="#a5b8f11869c456df354a87dabfaec97f1">&#9670;&nbsp;</a></span>~GrpcBufferReader()</h2>
  130. <div class="memitem">
  131. <div class="memproto">
  132. <table class="mlabels">
  133. <tr>
  134. <td class="mlabels-left">
  135. <table class="memname">
  136. <tr>
  137. <td class="memname">grpc::internal::GrpcBufferReader::~GrpcBufferReader </td>
  138. <td>(</td>
  139. <td class="paramname"></td><td>)</td>
  140. <td></td>
  141. </tr>
  142. </table>
  143. </td>
  144. <td class="mlabels-right">
  145. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span></span> </td>
  146. </tr>
  147. </table>
  148. </div><div class="memdoc">
  149. </div>
  150. </div>
  151. <h2 class="groupheader">Member Function Documentation</h2>
  152. <a id="a724c133b537616eee22562b3e89885c8"></a>
  153. <h2 class="memtitle"><span class="permalink"><a href="#a724c133b537616eee22562b3e89885c8">&#9670;&nbsp;</a></span>BackUp()</h2>
  154. <div class="memitem">
  155. <div class="memproto">
  156. <table class="mlabels">
  157. <tr>
  158. <td class="mlabels-left">
  159. <table class="memname">
  160. <tr>
  161. <td class="memname">void grpc::internal::GrpcBufferReader::BackUp </td>
  162. <td>(</td>
  163. <td class="paramtype">int&#160;</td>
  164. <td class="paramname"><em>count</em></td><td>)</td>
  165. <td></td>
  166. </tr>
  167. </table>
  168. </td>
  169. <td class="mlabels-right">
  170. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span></span> </td>
  171. </tr>
  172. </table>
  173. </div><div class="memdoc">
  174. </div>
  175. </div>
  176. <a id="acc660ae3172f370d7d2538f9fb9067b1"></a>
  177. <h2 class="memtitle"><span class="permalink"><a href="#acc660ae3172f370d7d2538f9fb9067b1">&#9670;&nbsp;</a></span>ByteCount()</h2>
  178. <div class="memitem">
  179. <div class="memproto">
  180. <table class="mlabels">
  181. <tr>
  182. <td class="mlabels-left">
  183. <table class="memname">
  184. <tr>
  185. <td class="memname"><a class="el" href="namespacegrpc_1_1protobuf.html#ad614bff24fe4674ca81af74c769a7b32">grpc::protobuf::int64</a> grpc::internal::GrpcBufferReader::ByteCount </td>
  186. <td>(</td>
  187. <td class="paramname"></td><td>)</td>
  188. <td> const</td>
  189. </tr>
  190. </table>
  191. </td>
  192. <td class="mlabels-right">
  193. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span></span> </td>
  194. </tr>
  195. </table>
  196. </div><div class="memdoc">
  197. </div>
  198. </div>
  199. <a id="ae66351a9aa970bdb225bbba45f279bb2"></a>
  200. <h2 class="memtitle"><span class="permalink"><a href="#ae66351a9aa970bdb225bbba45f279bb2">&#9670;&nbsp;</a></span>Next()</h2>
  201. <div class="memitem">
  202. <div class="memproto">
  203. <table class="mlabels">
  204. <tr>
  205. <td class="mlabels-left">
  206. <table class="memname">
  207. <tr>
  208. <td class="memname">bool grpc::internal::GrpcBufferReader::Next </td>
  209. <td>(</td>
  210. <td class="paramtype">const void **&#160;</td>
  211. <td class="paramname"><em>data</em>, </td>
  212. </tr>
  213. <tr>
  214. <td class="paramkey"></td>
  215. <td></td>
  216. <td class="paramtype">int *&#160;</td>
  217. <td class="paramname"><em>size</em>&#160;</td>
  218. </tr>
  219. <tr>
  220. <td></td>
  221. <td>)</td>
  222. <td></td><td></td>
  223. </tr>
  224. </table>
  225. </td>
  226. <td class="mlabels-right">
  227. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span></span> </td>
  228. </tr>
  229. </table>
  230. </div><div class="memdoc">
  231. </div>
  232. </div>
  233. <a id="a7aad5fe555993d8f86380e3b4c65db1c"></a>
  234. <h2 class="memtitle"><span class="permalink"><a href="#a7aad5fe555993d8f86380e3b4c65db1c">&#9670;&nbsp;</a></span>Skip()</h2>
  235. <div class="memitem">
  236. <div class="memproto">
  237. <table class="mlabels">
  238. <tr>
  239. <td class="mlabels-left">
  240. <table class="memname">
  241. <tr>
  242. <td class="memname">bool grpc::internal::GrpcBufferReader::Skip </td>
  243. <td>(</td>
  244. <td class="paramtype">int&#160;</td>
  245. <td class="paramname"><em>count</em></td><td>)</td>
  246. <td></td>
  247. </tr>
  248. </table>
  249. </td>
  250. <td class="mlabels-right">
  251. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span></span> </td>
  252. </tr>
  253. </table>
  254. </div><div class="memdoc">
  255. </div>
  256. </div>
  257. <a id="a34cf482f798ff91efce00096851f787b"></a>
  258. <h2 class="memtitle"><span class="permalink"><a href="#a34cf482f798ff91efce00096851f787b">&#9670;&nbsp;</a></span>status()</h2>
  259. <div class="memitem">
  260. <div class="memproto">
  261. <table class="mlabels">
  262. <tr>
  263. <td class="mlabels-left">
  264. <table class="memname">
  265. <tr>
  266. <td class="memname"><a class="el" href="classgrpc_1_1_status.html">Status</a> grpc::internal::GrpcBufferReader::status </td>
  267. <td>(</td>
  268. <td class="paramname"></td><td>)</td>
  269. <td> const</td>
  270. </tr>
  271. </table>
  272. </td>
  273. <td class="mlabels-right">
  274. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  275. </tr>
  276. </table>
  277. </div><div class="memdoc">
  278. </div>
  279. </div>
  280. <h2 class="groupheader">Field Documentation</h2>
  281. <a id="a1ea14debdd9fb96f8f94e755aea5904c"></a>
  282. <h2 class="memtitle"><span class="permalink"><a href="#a1ea14debdd9fb96f8f94e755aea5904c">&#9670;&nbsp;</a></span>backup_count_</h2>
  283. <div class="memitem">
  284. <div class="memproto">
  285. <table class="mlabels">
  286. <tr>
  287. <td class="mlabels-left">
  288. <table class="memname">
  289. <tr>
  290. <td class="memname">int64_t grpc::internal::GrpcBufferReader::backup_count_</td>
  291. </tr>
  292. </table>
  293. </td>
  294. <td class="mlabels-right">
  295. <span class="mlabels"><span class="mlabel">protected</span></span> </td>
  296. </tr>
  297. </table>
  298. </div><div class="memdoc">
  299. </div>
  300. </div>
  301. <a id="a0a6a65ef8eb5b5bb3d39a7b935ba78ab"></a>
  302. <h2 class="memtitle"><span class="permalink"><a href="#a0a6a65ef8eb5b5bb3d39a7b935ba78ab">&#9670;&nbsp;</a></span>byte_count_</h2>
  303. <div class="memitem">
  304. <div class="memproto">
  305. <table class="mlabels">
  306. <tr>
  307. <td class="mlabels-left">
  308. <table class="memname">
  309. <tr>
  310. <td class="memname">int64_t grpc::internal::GrpcBufferReader::byte_count_</td>
  311. </tr>
  312. </table>
  313. </td>
  314. <td class="mlabels-right">
  315. <span class="mlabels"><span class="mlabel">protected</span></span> </td>
  316. </tr>
  317. </table>
  318. </div><div class="memdoc">
  319. </div>
  320. </div>
  321. <a id="a52aae88ebfa452907a74625af1e2975e"></a>
  322. <h2 class="memtitle"><span class="permalink"><a href="#a52aae88ebfa452907a74625af1e2975e">&#9670;&nbsp;</a></span>reader_</h2>
  323. <div class="memitem">
  324. <div class="memproto">
  325. <table class="mlabels">
  326. <tr>
  327. <td class="mlabels-left">
  328. <table class="memname">
  329. <tr>
  330. <td class="memname"><a class="el" href="structgrpc__byte__buffer__reader.html">grpc_byte_buffer_reader</a> grpc::internal::GrpcBufferReader::reader_</td>
  331. </tr>
  332. </table>
  333. </td>
  334. <td class="mlabels-right">
  335. <span class="mlabels"><span class="mlabel">protected</span></span> </td>
  336. </tr>
  337. </table>
  338. </div><div class="memdoc">
  339. </div>
  340. </div>
  341. <a id="a74845b264add2937ff253114edb008cb"></a>
  342. <h2 class="memtitle"><span class="permalink"><a href="#a74845b264add2937ff253114edb008cb">&#9670;&nbsp;</a></span>slice_</h2>
  343. <div class="memitem">
  344. <div class="memproto">
  345. <table class="mlabels">
  346. <tr>
  347. <td class="mlabels-left">
  348. <table class="memname">
  349. <tr>
  350. <td class="memname"><a class="el" href="structgrpc__slice.html">grpc_slice</a> grpc::internal::GrpcBufferReader::slice_</td>
  351. </tr>
  352. </table>
  353. </td>
  354. <td class="mlabels-right">
  355. <span class="mlabels"><span class="mlabel">protected</span></span> </td>
  356. </tr>
  357. </table>
  358. </div><div class="memdoc">
  359. </div>
  360. </div>
  361. <a id="a85a798cb005abf72d2bc0a6a04e4bf92"></a>
  362. <h2 class="memtitle"><span class="permalink"><a href="#a85a798cb005abf72d2bc0a6a04e4bf92">&#9670;&nbsp;</a></span>status_</h2>
  363. <div class="memitem">
  364. <div class="memproto">
  365. <table class="mlabels">
  366. <tr>
  367. <td class="mlabels-left">
  368. <table class="memname">
  369. <tr>
  370. <td class="memname"><a class="el" href="classgrpc_1_1_status.html">Status</a> grpc::internal::GrpcBufferReader::status_</td>
  371. </tr>
  372. </table>
  373. </td>
  374. <td class="mlabels-right">
  375. <span class="mlabels"><span class="mlabel">protected</span></span> </td>
  376. </tr>
  377. </table>
  378. </div><div class="memdoc">
  379. </div>
  380. </div>
  381. <hr/>The documentation for this class was generated from the following file:<ul>
  382. <li>include/grpcpp/impl/codegen/<a class="el" href="grpcpp_2impl_2codegen_2proto__utils_8h_source.html">proto_utils.h</a></li>
  383. </ul>
  384. </div><!-- contents -->
  385. <!-- start footer part -->
  386. <hr class="footer"/><address class="footer"><small>
  387. Generated on Fri Apr 13 2018 15:03:53 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  388. <img class="footer" src="doxygen.png" alt="doxygen"/>
  389. </a> 1.8.13
  390. </small></address>
  391. </body>
  392. </html>