impl_2codegen_2interceptor_8h.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137
  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++: include/grpcpp/impl/codegen/interceptor.h File 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="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_412f9a3d5dfcba8716486cd870ef4586.html">grpcpp</a></li><li class="navelem"><a class="el" href="dir_84040d6f573b73aa8d12512b533ede11.html">impl</a></li><li class="navelem"><a class="el" href="dir_a33e3e3a3b205cffecbb359564791f71.html">codegen</a></li> </ul>
  64. </div>
  65. </div><!-- top -->
  66. <div class="header">
  67. <div class="summary">
  68. <a href="#nested-classes">Data Structures</a> &#124;
  69. <a href="#namespaces">Namespaces</a> &#124;
  70. <a href="#enum-members">Enumerations</a> </div>
  71. <div class="headertitle">
  72. <div class="title">interceptor.h File Reference</div> </div>
  73. </div><!--header-->
  74. <div class="contents">
  75. <div class="textblock"><code>#include &lt;memory&gt;</code><br />
  76. <code>#include &lt;<a class="el" href="grpc__types_8h_source.html">grpc/impl/codegen/grpc_types.h</a>&gt;</code><br />
  77. <code>#include &lt;<a class="el" href="grpcpp_2impl_2codegen_2byte__buffer_8h_source.html">grpcpp/impl/codegen/byte_buffer.h</a>&gt;</code><br />
  78. <code>#include &lt;<a class="el" href="grpcpp_2impl_2codegen_2config_8h_source.html">grpcpp/impl/codegen/config.h</a>&gt;</code><br />
  79. <code>#include &lt;<a class="el" href="grpcpp_2impl_2codegen_2core__codegen__interface_8h_source.html">grpcpp/impl/codegen/core_codegen_interface.h</a>&gt;</code><br />
  80. <code>#include &lt;<a class="el" href="grpcpp_2impl_2codegen_2metadata__map_8h_source.html">grpcpp/impl/codegen/metadata_map.h</a>&gt;</code><br />
  81. </div>
  82. <p><a href="impl_2codegen_2interceptor_8h_source.html">Go to the source code of this file.</a></p>
  83. <table class="memberdecls">
  84. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  85. Data Structures</h2></td></tr>
  86. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1experimental_1_1_interceptor_batch_methods.html">grpc::experimental::InterceptorBatchMethods</a></td></tr>
  87. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Class that is passed as an argument to the <em>Intercept</em> method of the application's <em><a class="el" href="classgrpc_1_1experimental_1_1_interceptor.html" title="Interface for an interceptor.">Interceptor</a></em> interface implementation. <a href="classgrpc_1_1experimental_1_1_interceptor_batch_methods.html#details">More...</a><br /></td></tr>
  88. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1experimental_1_1_interceptor.html">grpc::experimental::Interceptor</a></td></tr>
  90. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Interface for an interceptor. <a href="classgrpc_1_1experimental_1_1_interceptor.html#details">More...</a><br /></td></tr>
  91. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. </table><table class="memberdecls">
  93. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
  94. Namespaces</h2></td></tr>
  95. <tr class="memitem:namespacegrpc"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegrpc.html">grpc</a></td></tr>
  96. <tr class="memdesc:namespacegrpc"><td class="mdescLeft">&#160;</td><td class="mdescRight">An <a class="el" href="classgrpc_1_1_alarm.html">Alarm</a> posts the user-provided tag to its associated completion queue or invokes the user-provided function on expiry or cancellation. <br /></td></tr>
  97. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:namespacegrpc_1_1experimental"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegrpc_1_1experimental.html">grpc::experimental</a></td></tr>
  99. <tr class="memdesc:namespacegrpc_1_1experimental"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classgrpc_1_1experimental_1_1_client_rpc_info.html">ClientRpcInfo</a> represents the state of a particular RPC as it appears to an interceptor. <br /></td></tr>
  100. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. </table><table class="memberdecls">
  102. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
  103. Enumerations</h2></td></tr>
  104. <tr class="memitem:a03d3481b2c4146f53e90966d4a0fd8a1"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegrpc_1_1experimental.html#a03d3481b2c4146f53e90966d4a0fd8a1">grpc::experimental::InterceptionHookPoints</a> { <br />
  105. &#160;&#160;<a class="el" href="namespacegrpc_1_1experimental.html#a03d3481b2c4146f53e90966d4a0fd8a1a68f9cc22793a30bf451f5d94c283f371">grpc::experimental::InterceptionHookPoints::PRE_SEND_INITIAL_METADATA</a>,
  106. <a class="el" href="namespacegrpc_1_1experimental.html#a03d3481b2c4146f53e90966d4a0fd8a1a78e48d97d3b04c3bc07cc5e015bae473">grpc::experimental::InterceptionHookPoints::PRE_SEND_MESSAGE</a>,
  107. <a class="el" href="namespacegrpc_1_1experimental.html#a03d3481b2c4146f53e90966d4a0fd8a1a55a1a0825067b70bab918b67b298f038">grpc::experimental::InterceptionHookPoints::POST_SEND_MESSAGE</a>,
  108. <a class="el" href="namespacegrpc_1_1experimental.html#a03d3481b2c4146f53e90966d4a0fd8a1a787bde31497aaaccd0e780928a34ba3c">grpc::experimental::InterceptionHookPoints::PRE_SEND_STATUS</a>,
  109. <br />
  110. &#160;&#160;<a class="el" href="namespacegrpc_1_1experimental.html#a03d3481b2c4146f53e90966d4a0fd8a1aae41c3d206fb78da7ea1baff522fe734">grpc::experimental::InterceptionHookPoints::PRE_SEND_CLOSE</a>,
  111. <a class="el" href="namespacegrpc_1_1experimental.html#a03d3481b2c4146f53e90966d4a0fd8a1ae1edf7ebacfc20d107e332ed0df262d2">grpc::experimental::InterceptionHookPoints::PRE_RECV_INITIAL_METADATA</a>,
  112. <a class="el" href="namespacegrpc_1_1experimental.html#a03d3481b2c4146f53e90966d4a0fd8a1aed5412a55f4c64aab2e6492c79c91422">grpc::experimental::InterceptionHookPoints::PRE_RECV_MESSAGE</a>,
  113. <a class="el" href="namespacegrpc_1_1experimental.html#a03d3481b2c4146f53e90966d4a0fd8a1aac79efae31b3773d455797286cd0a3c3">grpc::experimental::InterceptionHookPoints::PRE_RECV_STATUS</a>,
  114. <br />
  115. &#160;&#160;<a class="el" href="namespacegrpc_1_1experimental.html#a03d3481b2c4146f53e90966d4a0fd8a1a294bdaeb2f3c15f0c7529ecdb04daea8">grpc::experimental::InterceptionHookPoints::POST_RECV_INITIAL_METADATA</a>,
  116. <a class="el" href="namespacegrpc_1_1experimental.html#a03d3481b2c4146f53e90966d4a0fd8a1ab65173742bb81f390a2bbe48279a1d22">grpc::experimental::InterceptionHookPoints::POST_RECV_MESSAGE</a>,
  117. <a class="el" href="namespacegrpc_1_1experimental.html#a03d3481b2c4146f53e90966d4a0fd8a1a97b298c9f3aa4e0b5b4865eaa93a5909">grpc::experimental::InterceptionHookPoints::POST_RECV_STATUS</a>,
  118. <a class="el" href="namespacegrpc_1_1experimental.html#a03d3481b2c4146f53e90966d4a0fd8a1a28873db230a854864aaf46ce3c7d282a">grpc::experimental::InterceptionHookPoints::POST_RECV_CLOSE</a>,
  119. <br />
  120. &#160;&#160;<a class="el" href="namespacegrpc_1_1experimental.html#a03d3481b2c4146f53e90966d4a0fd8a1afeaf95b857178c518bb74d59eb39aa23">grpc::experimental::InterceptionHookPoints::PRE_SEND_CANCEL</a>,
  121. <a class="el" href="namespacegrpc_1_1experimental.html#a03d3481b2c4146f53e90966d4a0fd8a1a005432205f3c52f3321eab4485d84c36">grpc::experimental::InterceptionHookPoints::NUM_INTERCEPTION_HOOKS</a>
  122. <br />
  123. }</td></tr>
  124. <tr class="memdesc:a03d3481b2c4146f53e90966d4a0fd8a1"><td class="mdescLeft">&#160;</td><td class="mdescRight">An enumeration of different possible points at which the <em>Intercept</em> method of the <em>Interceptor</em> interface may be called. <a href="namespacegrpc_1_1experimental.html#a03d3481b2c4146f53e90966d4a0fd8a1">More...</a><br /></td></tr>
  125. <tr class="separator:a03d3481b2c4146f53e90966d4a0fd8a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. </table>
  127. </div><!-- contents -->
  128. <!-- start footer part -->
  129. <hr class="footer"/><address class="footer"><small>
  130. Generated on Wed Mar 3 2021 19:17:22 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  131. <img class="footer" src="doxygen.png" alt="doxygen"/>
  132. </a> 1.8.17
  133. </small></address>
  134. </body>
  135. </html>