classgrpc_1_1experimental_1_1_interceptor.html 7.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156
  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::experimental::Interceptor 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.23.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_1experimental.html">experimental</a></li><li class="navelem"><a class="el" href="classgrpc_1_1experimental_1_1_interceptor.html">Interceptor</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> </div>
  66. <div class="headertitle">
  67. <div class="title">grpc::experimental::Interceptor Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
  68. </div><!--header-->
  69. <div class="contents">
  70. <p>Interface for an interceptor.
  71. <a href="classgrpc_1_1experimental_1_1_interceptor.html#details">More...</a></p>
  72. <p><code>#include &lt;<a class="el" href="impl_2codegen_2interceptor_8h_source.html">interceptor.h</a>&gt;</code></p>
  73. <table class="memberdecls">
  74. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  75. Public Member Functions</h2></td></tr>
  76. <tr class="memitem:a6bf6f97f95c4e8ec2c9da1bc7134394e"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1experimental_1_1_interceptor.html#a6bf6f97f95c4e8ec2c9da1bc7134394e">~Interceptor</a> ()</td></tr>
  77. <tr class="separator:a6bf6f97f95c4e8ec2c9da1bc7134394e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. <tr class="memitem:a19ed7b8e299ab0c50cc88174f28ecf55"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1experimental_1_1_interceptor.html#a19ed7b8e299ab0c50cc88174f28ecf55">Intercept</a> (<a class="el" href="classgrpc_1_1experimental_1_1_interceptor_batch_methods.html">InterceptorBatchMethods</a> *methods)=0</td></tr>
  79. <tr class="memdesc:a19ed7b8e299ab0c50cc88174f28ecf55"><td class="mdescLeft">&#160;</td><td class="mdescRight">The one public method of an <a class="el" href="classgrpc_1_1experimental_1_1_interceptor.html" title="Interface for an interceptor. ">Interceptor</a> interface. <a href="#a19ed7b8e299ab0c50cc88174f28ecf55">More...</a><br /></td></tr>
  80. <tr class="separator:a19ed7b8e299ab0c50cc88174f28ecf55"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. </table>
  82. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  83. <div class="textblock"><p>Interface for an interceptor. </p>
  84. <p><a class="el" href="classgrpc_1_1experimental_1_1_interceptor.html" title="Interface for an interceptor. ">Interceptor</a> authors must create a class that derives from this parent class. </p>
  85. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  86. <a id="a6bf6f97f95c4e8ec2c9da1bc7134394e"></a>
  87. <h2 class="memtitle"><span class="permalink"><a href="#a6bf6f97f95c4e8ec2c9da1bc7134394e">&#9670;&nbsp;</a></span>~Interceptor()</h2>
  88. <div class="memitem">
  89. <div class="memproto">
  90. <table class="mlabels">
  91. <tr>
  92. <td class="mlabels-left">
  93. <table class="memname">
  94. <tr>
  95. <td class="memname">virtual grpc::experimental::Interceptor::~Interceptor </td>
  96. <td>(</td>
  97. <td class="paramname"></td><td>)</td>
  98. <td></td>
  99. </tr>
  100. </table>
  101. </td>
  102. <td class="mlabels-right">
  103. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
  104. </tr>
  105. </table>
  106. </div><div class="memdoc">
  107. </div>
  108. </div>
  109. <h2 class="groupheader">Member Function Documentation</h2>
  110. <a id="a19ed7b8e299ab0c50cc88174f28ecf55"></a>
  111. <h2 class="memtitle"><span class="permalink"><a href="#a19ed7b8e299ab0c50cc88174f28ecf55">&#9670;&nbsp;</a></span>Intercept()</h2>
  112. <div class="memitem">
  113. <div class="memproto">
  114. <table class="mlabels">
  115. <tr>
  116. <td class="mlabels-left">
  117. <table class="memname">
  118. <tr>
  119. <td class="memname">virtual void grpc::experimental::Interceptor::Intercept </td>
  120. <td>(</td>
  121. <td class="paramtype"><a class="el" href="classgrpc_1_1experimental_1_1_interceptor_batch_methods.html">InterceptorBatchMethods</a> *&#160;</td>
  122. <td class="paramname"><em>methods</em></td><td>)</td>
  123. <td></td>
  124. </tr>
  125. </table>
  126. </td>
  127. <td class="mlabels-right">
  128. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  129. </tr>
  130. </table>
  131. </div><div class="memdoc">
  132. <p>The one public method of an <a class="el" href="classgrpc_1_1experimental_1_1_interceptor.html" title="Interface for an interceptor. ">Interceptor</a> interface. </p>
  133. <p>Override this to trigger the desired actions at the hook points described above. </p>
  134. </div>
  135. </div>
  136. <hr/>The documentation for this class was generated from the following file:<ul>
  137. <li>include/grpcpp/impl/codegen/<a class="el" href="impl_2codegen_2interceptor_8h_source.html">interceptor.h</a></li>
  138. </ul>
  139. </div><!-- contents -->
  140. <!-- start footer part -->
  141. <hr class="footer"/><address class="footer"><small>
  142. Generated on Mon Aug 19 2019 12:05:23 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  143. <img class="footer" src="doxygen.png" alt="doxygen"/>
  144. </a> 1.8.13
  145. </small></address>
  146. </body>
  147. </html>