classgrpc_1_1_server_1_1_global_callbacks.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315
  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.6"/>
  7. <title>GRPC C++: grpc::Server::GlobalCallbacks Class Reference</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  12. <script type="text/javascript" src="search/search.js"></script>
  13. <script type="text/javascript">
  14. $(document).ready(function() { searchBox.OnSelectItem(0); });
  15. </script>
  16. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  17. </head>
  18. <body>
  19. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  20. <div id="titlearea">
  21. <table cellspacing="0" cellpadding="0">
  22. <tbody>
  23. <tr style="height: 56px;">
  24. <td style="padding-left: 0.5em;">
  25. <div id="projectname">GRPC C++
  26. &#160;<span id="projectnumber">1.8.0</span>
  27. </div>
  28. </td>
  29. </tr>
  30. </tbody>
  31. </table>
  32. </div>
  33. <!-- end header part -->
  34. <!-- Generated by Doxygen 1.8.6 -->
  35. <script type="text/javascript">
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. </script>
  38. <div id="navrow1" class="tabs">
  39. <ul class="tablist">
  40. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  41. <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  42. <li><a href="modules.html"><span>Modules</span></a></li>
  43. <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  44. <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  45. <li><a href="files.html"><span>Files</span></a></li>
  46. <li>
  47. <div id="MSearchBox" class="MSearchBoxInactive">
  48. <span class="left">
  49. <img id="MSearchSelect" src="search/mag_sel.png"
  50. onmouseover="return searchBox.OnSearchSelectShow()"
  51. onmouseout="return searchBox.OnSearchSelectHide()"
  52. alt=""/>
  53. <input type="text" id="MSearchField" value="Search" accesskey="S"
  54. onfocus="searchBox.OnSearchFieldFocus(true)"
  55. onblur="searchBox.OnSearchFieldFocus(false)"
  56. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  57. </span><span class="right">
  58. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  59. </span>
  60. </div>
  61. </li>
  62. </ul>
  63. </div>
  64. <div id="navrow2" class="tabs2">
  65. <ul class="tablist">
  66. <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  67. <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
  68. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  69. <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
  70. </ul>
  71. </div>
  72. <!-- window showing the filter options -->
  73. <div id="MSearchSelectWindow"
  74. onmouseover="return searchBox.OnSearchSelectShow()"
  75. onmouseout="return searchBox.OnSearchSelectHide()"
  76. onkeydown="return searchBox.OnSearchSelectKey(event)">
  77. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(12)"><span class="SelectionMark">&#160;</span>Pages</a></div>
  78. <!-- iframe showing the search results (closed by default) -->
  79. <div id="MSearchResultsWindow">
  80. <iframe src="javascript:void(0)" frameborder="0"
  81. name="MSearchResults" id="MSearchResults">
  82. </iframe>
  83. </div>
  84. <div id="nav-path" class="navpath">
  85. <ul>
  86. <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>
  87. </div>
  88. </div><!-- top -->
  89. <div class="header">
  90. <div class="summary">
  91. <a href="#pub-methods">Public Member Functions</a> </div>
  92. <div class="headertitle">
  93. <div class="title">grpc::Server::GlobalCallbacks Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
  94. </div><!--header-->
  95. <div class="contents">
  96. <p>Global callbacks are a set of hooks that are called when server events occur.
  97. <a href="classgrpc_1_1_server_1_1_global_callbacks.html#details">More...</a></p>
  98. <p><code>#include &lt;<a class="el" href="server_8h_source.html">server.h</a>&gt;</code></p>
  99. <table class="memberdecls">
  100. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  101. Public Member Functions</h2></td></tr>
  102. <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>
  103. <tr class="separator:a973f3f4d86d6bd0589419d0b798ed12d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <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>
  105. <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>
  106. <tr class="separator:a5c7616e3cbb9b7e2df16a62ebfeb7a33"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <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>
  108. <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>
  109. <tr class="separator:a15b846ff19bee0bf9a3b929efc4b7e11"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <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>
  111. <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>
  112. <tr class="separator:a3a20848314924c94c349508e970138e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <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> *server)</td></tr>
  114. <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>
  115. <tr class="separator:a0700ca2be64da5a8caf318ed99dff165"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. <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> *server, 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>
  117. <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>
  118. <tr class="separator:a81922613de93b0565a282daada8ec12e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. </table>
  120. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  121. <div class="textblock"><p>Global callbacks are a set of hooks that are called when server events occur. </p>
  122. <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>
  123. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  124. <a class="anchor" id="a973f3f4d86d6bd0589419d0b798ed12d"></a>
  125. <div class="memitem">
  126. <div class="memproto">
  127. <table class="mlabels">
  128. <tr>
  129. <td class="mlabels-left">
  130. <table class="memname">
  131. <tr>
  132. <td class="memname">virtual grpc::Server::GlobalCallbacks::~GlobalCallbacks </td>
  133. <td>(</td>
  134. <td class="paramname"></td><td>)</td>
  135. <td></td>
  136. </tr>
  137. </table>
  138. </td>
  139. <td class="mlabels-right">
  140. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
  141. </tr>
  142. </table>
  143. </div><div class="memdoc">
  144. </div>
  145. </div>
  146. <h2 class="groupheader">Member Function Documentation</h2>
  147. <a class="anchor" id="a81922613de93b0565a282daada8ec12e"></a>
  148. <div class="memitem">
  149. <div class="memproto">
  150. <table class="mlabels">
  151. <tr>
  152. <td class="mlabels-left">
  153. <table class="memname">
  154. <tr>
  155. <td class="memname">virtual void grpc::Server::GlobalCallbacks::AddPort </td>
  156. <td>(</td>
  157. <td class="paramtype"><a class="el" href="classgrpc_1_1_server.html">Server</a> *&#160;</td>
  158. <td class="paramname"><em>server</em>, </td>
  159. </tr>
  160. <tr>
  161. <td class="paramkey"></td>
  162. <td></td>
  163. <td class="paramtype">const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;&#160;</td>
  164. <td class="paramname"><em>addr</em>, </td>
  165. </tr>
  166. <tr>
  167. <td class="paramkey"></td>
  168. <td></td>
  169. <td class="paramtype"><a class="el" href="classgrpc_1_1_server_credentials.html">ServerCredentials</a> *&#160;</td>
  170. <td class="paramname"><em>creds</em>, </td>
  171. </tr>
  172. <tr>
  173. <td class="paramkey"></td>
  174. <td></td>
  175. <td class="paramtype">int&#160;</td>
  176. <td class="paramname"><em>port</em>&#160;</td>
  177. </tr>
  178. <tr>
  179. <td></td>
  180. <td>)</td>
  181. <td></td><td></td>
  182. </tr>
  183. </table>
  184. </td>
  185. <td class="mlabels-right">
  186. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
  187. </tr>
  188. </table>
  189. </div><div class="memdoc">
  190. <p>Called after a server port is added. </p>
  191. </div>
  192. </div>
  193. <a class="anchor" id="a3a20848314924c94c349508e970138e9"></a>
  194. <div class="memitem">
  195. <div class="memproto">
  196. <table class="mlabels">
  197. <tr>
  198. <td class="mlabels-left">
  199. <table class="memname">
  200. <tr>
  201. <td class="memname">virtual void grpc::Server::GlobalCallbacks::PostSynchronousRequest </td>
  202. <td>(</td>
  203. <td class="paramtype"><a class="el" href="classgrpc_1_1_server_context.html">ServerContext</a> *&#160;</td>
  204. <td class="paramname"><em>context</em></td><td>)</td>
  205. <td></td>
  206. </tr>
  207. </table>
  208. </td>
  209. <td class="mlabels-right">
  210. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  211. </tr>
  212. </table>
  213. </div><div class="memdoc">
  214. <p>Called after application callback for each synchronous server request. </p>
  215. </div>
  216. </div>
  217. <a class="anchor" id="a0700ca2be64da5a8caf318ed99dff165"></a>
  218. <div class="memitem">
  219. <div class="memproto">
  220. <table class="mlabels">
  221. <tr>
  222. <td class="mlabels-left">
  223. <table class="memname">
  224. <tr>
  225. <td class="memname">virtual void grpc::Server::GlobalCallbacks::PreServerStart </td>
  226. <td>(</td>
  227. <td class="paramtype"><a class="el" href="classgrpc_1_1_server.html">Server</a> *&#160;</td>
  228. <td class="paramname"><em>server</em></td><td>)</td>
  229. <td></td>
  230. </tr>
  231. </table>
  232. </td>
  233. <td class="mlabels-right">
  234. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
  235. </tr>
  236. </table>
  237. </div><div class="memdoc">
  238. <p>Called before server is started. </p>
  239. </div>
  240. </div>
  241. <a class="anchor" id="a15b846ff19bee0bf9a3b929efc4b7e11"></a>
  242. <div class="memitem">
  243. <div class="memproto">
  244. <table class="mlabels">
  245. <tr>
  246. <td class="mlabels-left">
  247. <table class="memname">
  248. <tr>
  249. <td class="memname">virtual void grpc::Server::GlobalCallbacks::PreSynchronousRequest </td>
  250. <td>(</td>
  251. <td class="paramtype"><a class="el" href="classgrpc_1_1_server_context.html">ServerContext</a> *&#160;</td>
  252. <td class="paramname"><em>context</em></td><td>)</td>
  253. <td></td>
  254. </tr>
  255. </table>
  256. </td>
  257. <td class="mlabels-right">
  258. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  259. </tr>
  260. </table>
  261. </div><div class="memdoc">
  262. <p>Called before application callback for each synchronous server request. </p>
  263. </div>
  264. </div>
  265. <a class="anchor" id="a5c7616e3cbb9b7e2df16a62ebfeb7a33"></a>
  266. <div class="memitem">
  267. <div class="memproto">
  268. <table class="mlabels">
  269. <tr>
  270. <td class="mlabels-left">
  271. <table class="memname">
  272. <tr>
  273. <td class="memname">virtual void grpc::Server::GlobalCallbacks::UpdateArguments </td>
  274. <td>(</td>
  275. <td class="paramtype"><a class="el" href="classgrpc_1_1_channel_arguments.html">ChannelArguments</a> *&#160;</td>
  276. <td class="paramname"><em>args</em></td><td>)</td>
  277. <td></td>
  278. </tr>
  279. </table>
  280. </td>
  281. <td class="mlabels-right">
  282. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
  283. </tr>
  284. </table>
  285. </div><div class="memdoc">
  286. <p>Called before server is created. </p>
  287. </div>
  288. </div>
  289. <hr/>The documentation for this class was generated from the following file:<ul>
  290. <li>include/grpc++/<a class="el" href="server_8h_source.html">server.h</a></li>
  291. </ul>
  292. </div><!-- contents -->
  293. <!-- start footer part -->
  294. <hr class="footer"/><address class="footer"><small>
  295. Generated on Tue Dec 12 2017 18:36:13 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  296. <img class="footer" src="doxygen.png" alt="doxygen"/>
  297. </a> 1.8.6
  298. </small></address>
  299. </body>
  300. </html>