classgrpc_1_1_server_1_1_global_callbacks.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301
  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::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. <script type="text/javascript"> (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); ga('create', 'UA-60127042-1', 'auto'); ga('send', 'pageview'); </script></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.13.0-dev</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="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>
  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::Server::GlobalCallbacks Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
  68. </div><!--header-->
  69. <div class="contents">
  70. <p>Global callbacks are a set of hooks that are called when server events occur.
  71. <a href="classgrpc_1_1_server_1_1_global_callbacks.html#details">More...</a></p>
  72. <p><code>#include &lt;<a class="el" href="grpcpp_2server_8h_source.html">server.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: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>
  77. <tr class="separator:a973f3f4d86d6bd0589419d0b798ed12d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. <tr class="memitem:a5c7616e3cbb9b7e2df16a62ebfeb7a33"><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#a5c7616e3cbb9b7e2df16a62ebfeb7a33">UpdateArguments</a> (<a class="el" href="classgrpc_1_1_channel_arguments.html">ChannelArguments</a> *args)</td></tr>
  79. <tr class="memdesc:a5c7616e3cbb9b7e2df16a62ebfeb7a33"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called before server is created. <a href="#a5c7616e3cbb9b7e2df16a62ebfeb7a33">More...</a><br /></td></tr>
  80. <tr class="separator:a5c7616e3cbb9b7e2df16a62ebfeb7a33"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <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>
  82. <tr class="memdesc:a15b846ff19bee0bf9a3b929efc4b7e11"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called before application callback for each synchronous server request. <a href="#a15b846ff19bee0bf9a3b929efc4b7e11">More...</a><br /></td></tr>
  83. <tr class="separator:a15b846ff19bee0bf9a3b929efc4b7e11"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <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>
  85. <tr class="memdesc:a3a20848314924c94c349508e970138e9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called after application callback for each synchronous server request. <a href="#a3a20848314924c94c349508e970138e9">More...</a><br /></td></tr>
  86. <tr class="separator:a3a20848314924c94c349508e970138e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="memitem:a0700ca2be64da5a8caf318ed99dff165"><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#a0700ca2be64da5a8caf318ed99dff165">PreServerStart</a> (<a class="el" href="classgrpc_1_1_server.html">Server</a> *<a class="el" href="classgrpc_1_1_server.html#a01bdfb4554d12a10bdc9cf875ffa74dd">server</a>)</td></tr>
  88. <tr class="memdesc:a0700ca2be64da5a8caf318ed99dff165"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called before server is started. <a href="#a0700ca2be64da5a8caf318ed99dff165">More...</a><br /></td></tr>
  89. <tr class="separator:a0700ca2be64da5a8caf318ed99dff165"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:a81922613de93b0565a282daada8ec12e"><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#a81922613de93b0565a282daada8ec12e">AddPort</a> (<a class="el" href="classgrpc_1_1_server.html">Server</a> *<a class="el" href="classgrpc_1_1_server.html#a01bdfb4554d12a10bdc9cf875ffa74dd">server</a>, const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;addr, <a class="el" href="classgrpc_1_1_server_credentials.html">ServerCredentials</a> *creds, int port)</td></tr>
  91. <tr class="memdesc:a81922613de93b0565a282daada8ec12e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called after a server port is added. <a href="#a81922613de93b0565a282daada8ec12e">More...</a><br /></td></tr>
  92. <tr class="separator:a81922613de93b0565a282daada8ec12e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. </table>
  94. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  95. <div class="textblock"><p>Global callbacks are a set of hooks that are called when server events occur. </p>
  96. <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>
  97. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  98. <a id="a973f3f4d86d6bd0589419d0b798ed12d"></a>
  99. <h2 class="memtitle"><span class="permalink"><a href="#a973f3f4d86d6bd0589419d0b798ed12d">&#9670;&nbsp;</a></span>~GlobalCallbacks()</h2>
  100. <div class="memitem">
  101. <div class="memproto">
  102. <table class="mlabels">
  103. <tr>
  104. <td class="mlabels-left">
  105. <table class="memname">
  106. <tr>
  107. <td class="memname">virtual grpc::Server::GlobalCallbacks::~GlobalCallbacks </td>
  108. <td>(</td>
  109. <td class="paramname"></td><td>)</td>
  110. <td></td>
  111. </tr>
  112. </table>
  113. </td>
  114. <td class="mlabels-right">
  115. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
  116. </tr>
  117. </table>
  118. </div><div class="memdoc">
  119. </div>
  120. </div>
  121. <h2 class="groupheader">Member Function Documentation</h2>
  122. <a id="a81922613de93b0565a282daada8ec12e"></a>
  123. <h2 class="memtitle"><span class="permalink"><a href="#a81922613de93b0565a282daada8ec12e">&#9670;&nbsp;</a></span>AddPort()</h2>
  124. <div class="memitem">
  125. <div class="memproto">
  126. <table class="mlabels">
  127. <tr>
  128. <td class="mlabels-left">
  129. <table class="memname">
  130. <tr>
  131. <td class="memname">virtual void grpc::Server::GlobalCallbacks::AddPort </td>
  132. <td>(</td>
  133. <td class="paramtype"><a class="el" href="classgrpc_1_1_server.html">Server</a> *&#160;</td>
  134. <td class="paramname"><em>server</em>, </td>
  135. </tr>
  136. <tr>
  137. <td class="paramkey"></td>
  138. <td></td>
  139. <td class="paramtype">const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;&#160;</td>
  140. <td class="paramname"><em>addr</em>, </td>
  141. </tr>
  142. <tr>
  143. <td class="paramkey"></td>
  144. <td></td>
  145. <td class="paramtype"><a class="el" href="classgrpc_1_1_server_credentials.html">ServerCredentials</a> *&#160;</td>
  146. <td class="paramname"><em>creds</em>, </td>
  147. </tr>
  148. <tr>
  149. <td class="paramkey"></td>
  150. <td></td>
  151. <td class="paramtype">int&#160;</td>
  152. <td class="paramname"><em>port</em>&#160;</td>
  153. </tr>
  154. <tr>
  155. <td></td>
  156. <td>)</td>
  157. <td></td><td></td>
  158. </tr>
  159. </table>
  160. </td>
  161. <td class="mlabels-right">
  162. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
  163. </tr>
  164. </table>
  165. </div><div class="memdoc">
  166. <p>Called after a server port is added. </p>
  167. </div>
  168. </div>
  169. <a id="a3a20848314924c94c349508e970138e9"></a>
  170. <h2 class="memtitle"><span class="permalink"><a href="#a3a20848314924c94c349508e970138e9">&#9670;&nbsp;</a></span>PostSynchronousRequest()</h2>
  171. <div class="memitem">
  172. <div class="memproto">
  173. <table class="mlabels">
  174. <tr>
  175. <td class="mlabels-left">
  176. <table class="memname">
  177. <tr>
  178. <td class="memname">virtual void grpc::Server::GlobalCallbacks::PostSynchronousRequest </td>
  179. <td>(</td>
  180. <td class="paramtype"><a class="el" href="classgrpc_1_1_server_context.html">ServerContext</a> *&#160;</td>
  181. <td class="paramname"><em>context</em></td><td>)</td>
  182. <td></td>
  183. </tr>
  184. </table>
  185. </td>
  186. <td class="mlabels-right">
  187. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  188. </tr>
  189. </table>
  190. </div><div class="memdoc">
  191. <p>Called after application callback for each synchronous server request. </p>
  192. </div>
  193. </div>
  194. <a id="a0700ca2be64da5a8caf318ed99dff165"></a>
  195. <h2 class="memtitle"><span class="permalink"><a href="#a0700ca2be64da5a8caf318ed99dff165">&#9670;&nbsp;</a></span>PreServerStart()</h2>
  196. <div class="memitem">
  197. <div class="memproto">
  198. <table class="mlabels">
  199. <tr>
  200. <td class="mlabels-left">
  201. <table class="memname">
  202. <tr>
  203. <td class="memname">virtual void grpc::Server::GlobalCallbacks::PreServerStart </td>
  204. <td>(</td>
  205. <td class="paramtype"><a class="el" href="classgrpc_1_1_server.html">Server</a> *&#160;</td>
  206. <td class="paramname"><em>server</em></td><td>)</td>
  207. <td></td>
  208. </tr>
  209. </table>
  210. </td>
  211. <td class="mlabels-right">
  212. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
  213. </tr>
  214. </table>
  215. </div><div class="memdoc">
  216. <p>Called before server is started. </p>
  217. </div>
  218. </div>
  219. <a id="a15b846ff19bee0bf9a3b929efc4b7e11"></a>
  220. <h2 class="memtitle"><span class="permalink"><a href="#a15b846ff19bee0bf9a3b929efc4b7e11">&#9670;&nbsp;</a></span>PreSynchronousRequest()</h2>
  221. <div class="memitem">
  222. <div class="memproto">
  223. <table class="mlabels">
  224. <tr>
  225. <td class="mlabels-left">
  226. <table class="memname">
  227. <tr>
  228. <td class="memname">virtual void grpc::Server::GlobalCallbacks::PreSynchronousRequest </td>
  229. <td>(</td>
  230. <td class="paramtype"><a class="el" href="classgrpc_1_1_server_context.html">ServerContext</a> *&#160;</td>
  231. <td class="paramname"><em>context</em></td><td>)</td>
  232. <td></td>
  233. </tr>
  234. </table>
  235. </td>
  236. <td class="mlabels-right">
  237. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  238. </tr>
  239. </table>
  240. </div><div class="memdoc">
  241. <p>Called before application callback for each synchronous server request. </p>
  242. </div>
  243. </div>
  244. <a id="a5c7616e3cbb9b7e2df16a62ebfeb7a33"></a>
  245. <h2 class="memtitle"><span class="permalink"><a href="#a5c7616e3cbb9b7e2df16a62ebfeb7a33">&#9670;&nbsp;</a></span>UpdateArguments()</h2>
  246. <div class="memitem">
  247. <div class="memproto">
  248. <table class="mlabels">
  249. <tr>
  250. <td class="mlabels-left">
  251. <table class="memname">
  252. <tr>
  253. <td class="memname">virtual void grpc::Server::GlobalCallbacks::UpdateArguments </td>
  254. <td>(</td>
  255. <td class="paramtype"><a class="el" href="classgrpc_1_1_channel_arguments.html">ChannelArguments</a> *&#160;</td>
  256. <td class="paramname"><em>args</em></td><td>)</td>
  257. <td></td>
  258. </tr>
  259. </table>
  260. </td>
  261. <td class="mlabels-right">
  262. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
  263. </tr>
  264. </table>
  265. </div><div class="memdoc">
  266. <p>Called before server is created. </p>
  267. </div>
  268. </div>
  269. <hr/>The documentation for this class was generated from the following file:<ul>
  270. <li>include/grpcpp/<a class="el" href="grpcpp_2server_8h_source.html">server.h</a></li>
  271. </ul>
  272. </div><!-- contents -->
  273. <!-- start footer part -->
  274. <hr class="footer"/><address class="footer"><small>
  275. Generated on Tue May 15 2018 17:01:01 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  276. <img class="footer" src="doxygen.png" alt="doxygen"/>
  277. </a> 1.8.13
  278. </small></address>
  279. </body>
  280. </html>