classgrpc_1_1internal_1_1_call_op_set_interface.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>GRPC C++: grpc::internal::CallOpSetInterface 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.36.1</span>
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.8.17 -->
  34. <script type="text/javascript">
  35. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. /* @license-end */
  38. </script>
  39. <script type="text/javascript" src="menudata.js"></script>
  40. <script type="text/javascript" src="menu.js"></script>
  41. <script type="text/javascript">
  42. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  43. $(function() {
  44. initMenu('',true,false,'search.php','Search');
  45. $(document).ready(function() { init_search(); });
  46. });
  47. /* @license-end */</script>
  48. <div id="main-nav"></div>
  49. <!-- window showing the filter options -->
  50. <div id="MSearchSelectWindow"
  51. onmouseover="return searchBox.OnSearchSelectShow()"
  52. onmouseout="return searchBox.OnSearchSelectHide()"
  53. onkeydown="return searchBox.OnSearchSelectKey(event)">
  54. </div>
  55. <!-- iframe showing the search results (closed by default) -->
  56. <div id="MSearchResultsWindow">
  57. <iframe src="javascript:void(0)" frameborder="0"
  58. name="MSearchResults" id="MSearchResults">
  59. </iframe>
  60. </div>
  61. <div id="nav-path" class="navpath">
  62. <ul>
  63. <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_call_op_set_interface.html">CallOpSetInterface</a></li> </ul>
  64. </div>
  65. </div><!-- top -->
  66. <div class="header">
  67. <div class="summary">
  68. <a href="#pub-methods">Public Member Functions</a> </div>
  69. <div class="headertitle">
  70. <div class="title">grpc::internal::CallOpSetInterface Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
  71. </div><!--header-->
  72. <div class="contents">
  73. <p>An abstract collection of call ops, used to generate the grpc_call_op structure to pass down to the lower layers, and as it is-a <a class="el" href="classgrpc_1_1internal_1_1_completion_queue_tag.html" title="An interface allowing implementors to process and filter event tags.">CompletionQueueTag</a>, also massages the final completion into the correct form for consumption in the C++ API.
  74. <a href="classgrpc_1_1internal_1_1_call_op_set_interface.html#details">More...</a></p>
  75. <p><code>#include &lt;<a class="el" href="call__op__set__interface_8h_source.html">call_op_set_interface.h</a>&gt;</code></p>
  76. <table class="memberdecls">
  77. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  78. Public Member Functions</h2></td></tr>
  79. <tr class="memitem:aa054715a74b57c71cf3437caa01b138a"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_call_op_set_interface.html#aa054715a74b57c71cf3437caa01b138a">FillOps</a> (<a class="el" href="classgrpc_1_1internal_1_1_call.html">internal::Call</a> *call)=0</td></tr>
  80. <tr class="memdesc:aa054715a74b57c71cf3437caa01b138a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fills in <a class="el" href="structgrpc__op.html" title="Operation data: one field for each op type (except SEND_CLOSE_FROM_CLIENT which has no arguments)">grpc_op</a>, starting from ops[*nops] and moving upwards. <a href="classgrpc_1_1internal_1_1_call_op_set_interface.html#aa054715a74b57c71cf3437caa01b138a">More...</a><br /></td></tr>
  81. <tr class="separator:aa054715a74b57c71cf3437caa01b138a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <tr class="memitem:a20c76c26f622d29b2bc1a064123fe68c"><td class="memItemLeft" align="right" valign="top">virtual void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_call_op_set_interface.html#a20c76c26f622d29b2bc1a064123fe68c">core_cq_tag</a> ()=0</td></tr>
  83. <tr class="memdesc:a20c76c26f622d29b2bc1a064123fe68c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the tag to be used at the core completion queue. <a href="classgrpc_1_1internal_1_1_call_op_set_interface.html#a20c76c26f622d29b2bc1a064123fe68c">More...</a><br /></td></tr>
  84. <tr class="separator:a20c76c26f622d29b2bc1a064123fe68c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr class="memitem:a284de4e60b1546872c64d051c85c2977"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_call_op_set_interface.html#a284de4e60b1546872c64d051c85c2977">SetHijackingState</a> ()=0</td></tr>
  86. <tr class="separator:a284de4e60b1546872c64d051c85c2977"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="memitem:a5b3641829d7082f83146d17157f1bf38"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_call_op_set_interface.html#a5b3641829d7082f83146d17157f1bf38">ContinueFillOpsAfterInterception</a> ()=0</td></tr>
  88. <tr class="separator:a5b3641829d7082f83146d17157f1bf38"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <tr class="memitem:a6218c0c884e8bfd7fa440ee6d15b2397"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_call_op_set_interface.html#a6218c0c884e8bfd7fa440ee6d15b2397">ContinueFinalizeResultAfterInterception</a> ()=0</td></tr>
  90. <tr class="separator:a6218c0c884e8bfd7fa440ee6d15b2397"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. <tr class="inherit_header pub_methods_classgrpc_1_1internal_1_1_completion_queue_tag"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgrpc_1_1internal_1_1_completion_queue_tag')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classgrpc_1_1internal_1_1_completion_queue_tag.html">grpc::internal::CompletionQueueTag</a></td></tr>
  92. <tr class="memitem:a53fa1b2f86702495363df0b8edef8758 inherit pub_methods_classgrpc_1_1internal_1_1_completion_queue_tag"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_completion_queue_tag.html#a53fa1b2f86702495363df0b8edef8758">~CompletionQueueTag</a> ()</td></tr>
  93. <tr class="separator:a53fa1b2f86702495363df0b8edef8758 inherit pub_methods_classgrpc_1_1internal_1_1_completion_queue_tag"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:a554869ba610e1dca49b86bd6913587ba inherit pub_methods_classgrpc_1_1internal_1_1_completion_queue_tag"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_completion_queue_tag.html#a554869ba610e1dca49b86bd6913587ba">FinalizeResult</a> (void **tag, bool *status)=0</td></tr>
  95. <tr class="memdesc:a554869ba610e1dca49b86bd6913587ba inherit pub_methods_classgrpc_1_1internal_1_1_completion_queue_tag"><td class="mdescLeft">&#160;</td><td class="mdescRight">FinalizeResult must be called before informing user code that the operation bound to the underlying core completion queue tag has completed. <a href="classgrpc_1_1internal_1_1_completion_queue_tag.html#a554869ba610e1dca49b86bd6913587ba">More...</a><br /></td></tr>
  96. <tr class="separator:a554869ba610e1dca49b86bd6913587ba inherit pub_methods_classgrpc_1_1internal_1_1_completion_queue_tag"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. </table>
  98. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  99. <div class="textblock"><p>An abstract collection of call ops, used to generate the grpc_call_op structure to pass down to the lower layers, and as it is-a <a class="el" href="classgrpc_1_1internal_1_1_completion_queue_tag.html" title="An interface allowing implementors to process and filter event tags.">CompletionQueueTag</a>, also massages the final completion into the correct form for consumption in the C++ API. </p>
  100. </div><h2 class="groupheader">Member Function Documentation</h2>
  101. <a id="a5b3641829d7082f83146d17157f1bf38"></a>
  102. <h2 class="memtitle"><span class="permalink"><a href="#a5b3641829d7082f83146d17157f1bf38">&#9670;&nbsp;</a></span>ContinueFillOpsAfterInterception()</h2>
  103. <div class="memitem">
  104. <div class="memproto">
  105. <table class="mlabels">
  106. <tr>
  107. <td class="mlabels-left">
  108. <table class="memname">
  109. <tr>
  110. <td class="memname">virtual void grpc::internal::CallOpSetInterface::ContinueFillOpsAfterInterception </td>
  111. <td>(</td>
  112. <td class="paramname"></td><td>)</td>
  113. <td></td>
  114. </tr>
  115. </table>
  116. </td>
  117. <td class="mlabels-right">
  118. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  119. </tr>
  120. </table>
  121. </div><div class="memdoc">
  122. </div>
  123. </div>
  124. <a id="a6218c0c884e8bfd7fa440ee6d15b2397"></a>
  125. <h2 class="memtitle"><span class="permalink"><a href="#a6218c0c884e8bfd7fa440ee6d15b2397">&#9670;&nbsp;</a></span>ContinueFinalizeResultAfterInterception()</h2>
  126. <div class="memitem">
  127. <div class="memproto">
  128. <table class="mlabels">
  129. <tr>
  130. <td class="mlabels-left">
  131. <table class="memname">
  132. <tr>
  133. <td class="memname">virtual void grpc::internal::CallOpSetInterface::ContinueFinalizeResultAfterInterception </td>
  134. <td>(</td>
  135. <td class="paramname"></td><td>)</td>
  136. <td></td>
  137. </tr>
  138. </table>
  139. </td>
  140. <td class="mlabels-right">
  141. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  142. </tr>
  143. </table>
  144. </div><div class="memdoc">
  145. </div>
  146. </div>
  147. <a id="a20c76c26f622d29b2bc1a064123fe68c"></a>
  148. <h2 class="memtitle"><span class="permalink"><a href="#a20c76c26f622d29b2bc1a064123fe68c">&#9670;&nbsp;</a></span>core_cq_tag()</h2>
  149. <div class="memitem">
  150. <div class="memproto">
  151. <table class="mlabels">
  152. <tr>
  153. <td class="mlabels-left">
  154. <table class="memname">
  155. <tr>
  156. <td class="memname">virtual void* grpc::internal::CallOpSetInterface::core_cq_tag </td>
  157. <td>(</td>
  158. <td class="paramname"></td><td>)</td>
  159. <td></td>
  160. </tr>
  161. </table>
  162. </td>
  163. <td class="mlabels-right">
  164. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  165. </tr>
  166. </table>
  167. </div><div class="memdoc">
  168. <p>Get the tag to be used at the core completion queue. </p>
  169. <p>Generally, the value of core_cq_tag will be "this". However, it can be overridden if we want core to process the tag differently (e.g., as a core callback) </p>
  170. </div>
  171. </div>
  172. <a id="aa054715a74b57c71cf3437caa01b138a"></a>
  173. <h2 class="memtitle"><span class="permalink"><a href="#aa054715a74b57c71cf3437caa01b138a">&#9670;&nbsp;</a></span>FillOps()</h2>
  174. <div class="memitem">
  175. <div class="memproto">
  176. <table class="mlabels">
  177. <tr>
  178. <td class="mlabels-left">
  179. <table class="memname">
  180. <tr>
  181. <td class="memname">virtual void grpc::internal::CallOpSetInterface::FillOps </td>
  182. <td>(</td>
  183. <td class="paramtype"><a class="el" href="classgrpc_1_1internal_1_1_call.html">internal::Call</a> *&#160;</td>
  184. <td class="paramname"><em>call</em></td><td>)</td>
  185. <td></td>
  186. </tr>
  187. </table>
  188. </td>
  189. <td class="mlabels-right">
  190. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  191. </tr>
  192. </table>
  193. </div><div class="memdoc">
  194. <p>Fills in <a class="el" href="structgrpc__op.html" title="Operation data: one field for each op type (except SEND_CLOSE_FROM_CLIENT which has no arguments)">grpc_op</a>, starting from ops[*nops] and moving upwards. </p>
  195. </div>
  196. </div>
  197. <a id="a284de4e60b1546872c64d051c85c2977"></a>
  198. <h2 class="memtitle"><span class="permalink"><a href="#a284de4e60b1546872c64d051c85c2977">&#9670;&nbsp;</a></span>SetHijackingState()</h2>
  199. <div class="memitem">
  200. <div class="memproto">
  201. <table class="mlabels">
  202. <tr>
  203. <td class="mlabels-left">
  204. <table class="memname">
  205. <tr>
  206. <td class="memname">virtual void grpc::internal::CallOpSetInterface::SetHijackingState </td>
  207. <td>(</td>
  208. <td class="paramname"></td><td>)</td>
  209. <td></td>
  210. </tr>
  211. </table>
  212. </td>
  213. <td class="mlabels-right">
  214. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  215. </tr>
  216. </table>
  217. </div><div class="memdoc">
  218. </div>
  219. </div>
  220. <hr/>The documentation for this class was generated from the following file:<ul>
  221. <li>include/grpcpp/impl/codegen/<a class="el" href="call__op__set__interface_8h_source.html">call_op_set_interface.h</a></li>
  222. </ul>
  223. </div><!-- contents -->
  224. <!-- start footer part -->
  225. <hr class="footer"/><address class="footer"><small>
  226. Generated on Wed Mar 3 2021 19:17:26 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  227. <img class="footer" src="doxygen.png" alt="doxygen"/>
  228. </a> 1.8.17
  229. </small></address>
  230. </body>
  231. </html>