classgrpc_1_1_server_1_1_global_callbacks.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304
  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::Server::GlobalCallbacks 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="classgrpc_1_1_server.html">Server</a></li><li class="navelem"><a class="el" href="classgrpc_1_1_server_1_1_global_callbacks.html">GlobalCallbacks</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::Server::GlobalCallbacks Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
  71. </div><!--header-->
  72. <div class="contents">
  73. <p>Global callbacks are a set of hooks that are called when server events occur.
  74. <a href="classgrpc_1_1_server_1_1_global_callbacks.html#details">More...</a></p>
  75. <p><code>#include &lt;<a class="el" href="grpcpp_2server_8h_source.html">server.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:a973f3f4d86d6bd0589419d0b798ed12d"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_1_1_global_callbacks.html#a973f3f4d86d6bd0589419d0b798ed12d">~GlobalCallbacks</a> ()</td></tr>
  80. <tr class="separator:a973f3f4d86d6bd0589419d0b798ed12d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:a8598181d5682b98a7df098a6a68538d8"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_1_1_global_callbacks.html#a8598181d5682b98a7df098a6a68538d8">UpdateArguments</a> (<a class="el" href="classgrpc_1_1_channel_arguments.html">ChannelArguments</a> *)</td></tr>
  82. <tr class="memdesc:a8598181d5682b98a7df098a6a68538d8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called before server is created. <a href="classgrpc_1_1_server_1_1_global_callbacks.html#a8598181d5682b98a7df098a6a68538d8">More...</a><br /></td></tr>
  83. <tr class="separator:a8598181d5682b98a7df098a6a68538d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:a15b846ff19bee0bf9a3b929efc4b7e11"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_1_1_global_callbacks.html#a15b846ff19bee0bf9a3b929efc4b7e11">PreSynchronousRequest</a> (<a class="el" href="classgrpc_1_1_server_context.html">ServerContext</a> *context)=0</td></tr>
  85. <tr class="memdesc:a15b846ff19bee0bf9a3b929efc4b7e11"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called before application callback for each synchronous server request. <a href="classgrpc_1_1_server_1_1_global_callbacks.html#a15b846ff19bee0bf9a3b929efc4b7e11">More...</a><br /></td></tr>
  86. <tr class="separator:a15b846ff19bee0bf9a3b929efc4b7e11"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="memitem:a3a20848314924c94c349508e970138e9"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_1_1_global_callbacks.html#a3a20848314924c94c349508e970138e9">PostSynchronousRequest</a> (<a class="el" href="classgrpc_1_1_server_context.html">ServerContext</a> *context)=0</td></tr>
  88. <tr class="memdesc:a3a20848314924c94c349508e970138e9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called after application callback for each synchronous server request. <a href="classgrpc_1_1_server_1_1_global_callbacks.html#a3a20848314924c94c349508e970138e9">More...</a><br /></td></tr>
  89. <tr class="separator:a3a20848314924c94c349508e970138e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:ac063cfd6091a1af15e41d4b852105a66"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_1_1_global_callbacks.html#ac063cfd6091a1af15e41d4b852105a66">PreServerStart</a> (<a class="el" href="classgrpc_1_1_server.html">Server</a> *)</td></tr>
  91. <tr class="memdesc:ac063cfd6091a1af15e41d4b852105a66"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called before server is started. <a href="classgrpc_1_1_server_1_1_global_callbacks.html#ac063cfd6091a1af15e41d4b852105a66">More...</a><br /></td></tr>
  92. <tr class="separator:ac063cfd6091a1af15e41d4b852105a66"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <tr class="memitem:af0c4a9b001a9cb6731b5251e0ef5daca"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_1_1_global_callbacks.html#af0c4a9b001a9cb6731b5251e0ef5daca">AddPort</a> (<a class="el" href="classgrpc_1_1_server.html">Server</a> *, const std::string &amp;, <a class="el" href="classgrpc_1_1_server_credentials.html">ServerCredentials</a> *, int)</td></tr>
  94. <tr class="memdesc:af0c4a9b001a9cb6731b5251e0ef5daca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called after a server port is added. <a href="classgrpc_1_1_server_1_1_global_callbacks.html#af0c4a9b001a9cb6731b5251e0ef5daca">More...</a><br /></td></tr>
  95. <tr class="separator:af0c4a9b001a9cb6731b5251e0ef5daca"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. </table>
  97. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  98. <div class="textblock"><p>Global callbacks are a set of hooks that are called when server events occur. </p>
  99. <p><em>SetGlobalCallbacks</em> method is used to register the hooks with gRPC. Note that the <em><a class="el" href="classgrpc_1_1_server_1_1_global_callbacks.html" title="Global callbacks are a set of hooks that are called when server events occur.">GlobalCallbacks</a></em> instance will be shared among all <em><a class="el" href="classgrpc_1_1_server.html" title="Represents a gRPC server.">Server</a></em> instances in an application and can be set exactly once per application. </p>
  100. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  101. <a id="a973f3f4d86d6bd0589419d0b798ed12d"></a>
  102. <h2 class="memtitle"><span class="permalink"><a href="#a973f3f4d86d6bd0589419d0b798ed12d">&#9670;&nbsp;</a></span>~GlobalCallbacks()</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 grpc::Server::GlobalCallbacks::~GlobalCallbacks </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">inline</span><span class="mlabel">virtual</span></span> </td>
  119. </tr>
  120. </table>
  121. </div><div class="memdoc">
  122. </div>
  123. </div>
  124. <h2 class="groupheader">Member Function Documentation</h2>
  125. <a id="af0c4a9b001a9cb6731b5251e0ef5daca"></a>
  126. <h2 class="memtitle"><span class="permalink"><a href="#af0c4a9b001a9cb6731b5251e0ef5daca">&#9670;&nbsp;</a></span>AddPort()</h2>
  127. <div class="memitem">
  128. <div class="memproto">
  129. <table class="mlabels">
  130. <tr>
  131. <td class="mlabels-left">
  132. <table class="memname">
  133. <tr>
  134. <td class="memname">virtual void grpc::Server::GlobalCallbacks::AddPort </td>
  135. <td>(</td>
  136. <td class="paramtype"><a class="el" href="classgrpc_1_1_server.html">Server</a> *&#160;</td>
  137. <td class="paramname">, </td>
  138. </tr>
  139. <tr>
  140. <td class="paramkey"></td>
  141. <td></td>
  142. <td class="paramtype">const std::string &amp;&#160;</td>
  143. <td class="paramname">, </td>
  144. </tr>
  145. <tr>
  146. <td class="paramkey"></td>
  147. <td></td>
  148. <td class="paramtype"><a class="el" href="classgrpc_1_1_server_credentials.html">ServerCredentials</a> *&#160;</td>
  149. <td class="paramname">, </td>
  150. </tr>
  151. <tr>
  152. <td class="paramkey"></td>
  153. <td></td>
  154. <td class="paramtype">int&#160;</td>
  155. <td class="paramname">&#160;</td>
  156. </tr>
  157. <tr>
  158. <td></td>
  159. <td>)</td>
  160. <td></td><td></td>
  161. </tr>
  162. </table>
  163. </td>
  164. <td class="mlabels-right">
  165. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
  166. </tr>
  167. </table>
  168. </div><div class="memdoc">
  169. <p>Called after a server port is added. </p>
  170. </div>
  171. </div>
  172. <a id="a3a20848314924c94c349508e970138e9"></a>
  173. <h2 class="memtitle"><span class="permalink"><a href="#a3a20848314924c94c349508e970138e9">&#9670;&nbsp;</a></span>PostSynchronousRequest()</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::Server::GlobalCallbacks::PostSynchronousRequest </td>
  182. <td>(</td>
  183. <td class="paramtype"><a class="el" href="classgrpc_1_1_server_context.html">ServerContext</a> *&#160;</td>
  184. <td class="paramname"><em>context</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>Called after application callback for each synchronous server request. </p>
  195. </div>
  196. </div>
  197. <a id="ac063cfd6091a1af15e41d4b852105a66"></a>
  198. <h2 class="memtitle"><span class="permalink"><a href="#ac063cfd6091a1af15e41d4b852105a66">&#9670;&nbsp;</a></span>PreServerStart()</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::Server::GlobalCallbacks::PreServerStart </td>
  207. <td>(</td>
  208. <td class="paramtype"><a class="el" href="classgrpc_1_1_server.html">Server</a> *&#160;</td>
  209. <td class="paramname"></td><td>)</td>
  210. <td></td>
  211. </tr>
  212. </table>
  213. </td>
  214. <td class="mlabels-right">
  215. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
  216. </tr>
  217. </table>
  218. </div><div class="memdoc">
  219. <p>Called before server is started. </p>
  220. </div>
  221. </div>
  222. <a id="a15b846ff19bee0bf9a3b929efc4b7e11"></a>
  223. <h2 class="memtitle"><span class="permalink"><a href="#a15b846ff19bee0bf9a3b929efc4b7e11">&#9670;&nbsp;</a></span>PreSynchronousRequest()</h2>
  224. <div class="memitem">
  225. <div class="memproto">
  226. <table class="mlabels">
  227. <tr>
  228. <td class="mlabels-left">
  229. <table class="memname">
  230. <tr>
  231. <td class="memname">virtual void grpc::Server::GlobalCallbacks::PreSynchronousRequest </td>
  232. <td>(</td>
  233. <td class="paramtype"><a class="el" href="classgrpc_1_1_server_context.html">ServerContext</a> *&#160;</td>
  234. <td class="paramname"><em>context</em></td><td>)</td>
  235. <td></td>
  236. </tr>
  237. </table>
  238. </td>
  239. <td class="mlabels-right">
  240. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  241. </tr>
  242. </table>
  243. </div><div class="memdoc">
  244. <p>Called before application callback for each synchronous server request. </p>
  245. </div>
  246. </div>
  247. <a id="a8598181d5682b98a7df098a6a68538d8"></a>
  248. <h2 class="memtitle"><span class="permalink"><a href="#a8598181d5682b98a7df098a6a68538d8">&#9670;&nbsp;</a></span>UpdateArguments()</h2>
  249. <div class="memitem">
  250. <div class="memproto">
  251. <table class="mlabels">
  252. <tr>
  253. <td class="mlabels-left">
  254. <table class="memname">
  255. <tr>
  256. <td class="memname">virtual void grpc::Server::GlobalCallbacks::UpdateArguments </td>
  257. <td>(</td>
  258. <td class="paramtype"><a class="el" href="classgrpc_1_1_channel_arguments.html">ChannelArguments</a> *&#160;</td>
  259. <td class="paramname"></td><td>)</td>
  260. <td></td>
  261. </tr>
  262. </table>
  263. </td>
  264. <td class="mlabels-right">
  265. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
  266. </tr>
  267. </table>
  268. </div><div class="memdoc">
  269. <p>Called before server is created. </p>
  270. </div>
  271. </div>
  272. <hr/>The documentation for this class was generated from the following file:<ul>
  273. <li>include/grpcpp/<a class="el" href="grpcpp_2server_8h_source.html">server.h</a></li>
  274. </ul>
  275. </div><!-- contents -->
  276. <!-- start footer part -->
  277. <hr class="footer"/><address class="footer"><small>
  278. Generated on Wed Mar 3 2021 19:17:24 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  279. <img class="footer" src="doxygen.png" alt="doxygen"/>
  280. </a> 1.8.17
  281. </small></address>
  282. </body>
  283. </html>