| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
- <meta http-equiv="X-UA-Compatible" content="IE=9"/>
- <meta name="generator" content="Doxygen 1.8.17"/>
- <meta name="viewport" content="width=device-width, initial-scale=1"/>
- <title>GRPC C++: grpc_impl::Server::GlobalCallbacks Class Reference</title>
- <link href="tabs.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="jquery.js"></script>
- <script type="text/javascript" src="dynsections.js"></script>
- <link href="search/search.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="search/searchdata.js"></script>
- <script type="text/javascript" src="search/search.js"></script>
- <link href="doxygen.css" rel="stylesheet" type="text/css" />
- </head>
- <body>
- <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
- <div id="titlearea">
- <table cellspacing="0" cellpadding="0">
- <tbody>
- <tr style="height: 56px;">
- <td id="projectalign" style="padding-left: 0.5em;">
- <div id="projectname">GRPC C++
-  <span id="projectnumber">1.32.0</span>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.8.17 -->
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
- var searchBox = new SearchBox("searchBox", "search",false,'Search');
- /* @license-end */
- </script>
- <script type="text/javascript" src="menudata.js"></script>
- <script type="text/javascript" src="menu.js"></script>
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
- $(function() {
- initMenu('',true,false,'search.php','Search');
- $(document).ready(function() { init_search(); });
- });
- /* @license-end */</script>
- <div id="main-nav"></div>
- <!-- window showing the filter options -->
- <div id="MSearchSelectWindow"
- onmouseover="return searchBox.OnSearchSelectShow()"
- onmouseout="return searchBox.OnSearchSelectHide()"
- onkeydown="return searchBox.OnSearchSelectKey(event)">
- </div>
- <!-- iframe showing the search results (closed by default) -->
- <div id="MSearchResultsWindow">
- <iframe src="javascript:void(0)" frameborder="0"
- name="MSearchResults" id="MSearchResults">
- </iframe>
- </div>
- <div id="nav-path" class="navpath">
- <ul>
- <li class="navelem"><a class="el" href="namespacegrpc__impl.html">grpc_impl</a></li><li class="navelem"><a class="el" href="classgrpc__impl_1_1_server.html">Server</a></li><li class="navelem"><a class="el" href="classgrpc__impl_1_1_server_1_1_global_callbacks.html">GlobalCallbacks</a></li> </ul>
- </div>
- </div><!-- top -->
- <div class="header">
- <div class="summary">
- <a href="#pub-methods">Public Member Functions</a> </div>
- <div class="headertitle">
- <div class="title">grpc_impl::Server::GlobalCallbacks Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
- </div><!--header-->
- <div class="contents">
- <p>Global callbacks are a set of hooks that are called when server events occur.
- <a href="classgrpc__impl_1_1_server_1_1_global_callbacks.html#details">More...</a></p>
- <p><code>#include <<a class="el" href="server__impl_8h_source.html">server_impl.h</a>></code></p>
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
- Public Member Functions</h2></td></tr>
- <tr class="memitem:a4b8e77bfae7312ffbcc66c4115e58e8c"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_server_1_1_global_callbacks.html#a4b8e77bfae7312ffbcc66c4115e58e8c">~GlobalCallbacks</a> ()</td></tr>
- <tr class="separator:a4b8e77bfae7312ffbcc66c4115e58e8c"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a0e4e8960ad8f1cba761091a4e390fd0a"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_server_1_1_global_callbacks.html#a0e4e8960ad8f1cba761091a4e390fd0a">UpdateArguments</a> (<a class="el" href="classgrpc_1_1_channel_arguments.html">grpc::ChannelArguments</a> *)</td></tr>
- <tr class="memdesc:a0e4e8960ad8f1cba761091a4e390fd0a"><td class="mdescLeft"> </td><td class="mdescRight">Called before server is created. <a href="classgrpc__impl_1_1_server_1_1_global_callbacks.html#a0e4e8960ad8f1cba761091a4e390fd0a">More...</a><br /></td></tr>
- <tr class="separator:a0e4e8960ad8f1cba761091a4e390fd0a"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a3b8319323879d19bc9a4de5a4a744193"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_server_1_1_global_callbacks.html#a3b8319323879d19bc9a4de5a4a744193">PreSynchronousRequest</a> (<a class="el" href="classgrpc__impl_1_1_server_context.html">grpc_impl::ServerContext</a> *context)=0</td></tr>
- <tr class="memdesc:a3b8319323879d19bc9a4de5a4a744193"><td class="mdescLeft"> </td><td class="mdescRight">Called before application callback for each synchronous server request. <a href="classgrpc__impl_1_1_server_1_1_global_callbacks.html#a3b8319323879d19bc9a4de5a4a744193">More...</a><br /></td></tr>
- <tr class="separator:a3b8319323879d19bc9a4de5a4a744193"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab881b0088cf1fa639d514d1dc3918334"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_server_1_1_global_callbacks.html#ab881b0088cf1fa639d514d1dc3918334">PostSynchronousRequest</a> (<a class="el" href="classgrpc__impl_1_1_server_context.html">grpc_impl::ServerContext</a> *context)=0</td></tr>
- <tr class="memdesc:ab881b0088cf1fa639d514d1dc3918334"><td class="mdescLeft"> </td><td class="mdescRight">Called after application callback for each synchronous server request. <a href="classgrpc__impl_1_1_server_1_1_global_callbacks.html#ab881b0088cf1fa639d514d1dc3918334">More...</a><br /></td></tr>
- <tr class="separator:ab881b0088cf1fa639d514d1dc3918334"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a54763e2c30add4fabb3bc62b18231d0b"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_server_1_1_global_callbacks.html#a54763e2c30add4fabb3bc62b18231d0b">PreServerStart</a> (<a class="el" href="classgrpc__impl_1_1_server.html">Server</a> *)</td></tr>
- <tr class="memdesc:a54763e2c30add4fabb3bc62b18231d0b"><td class="mdescLeft"> </td><td class="mdescRight">Called before server is started. <a href="classgrpc__impl_1_1_server_1_1_global_callbacks.html#a54763e2c30add4fabb3bc62b18231d0b">More...</a><br /></td></tr>
- <tr class="separator:a54763e2c30add4fabb3bc62b18231d0b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ae1c370f5d884b638485675f996bae29a"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_server_1_1_global_callbacks.html#ae1c370f5d884b638485675f996bae29a">AddPort</a> (<a class="el" href="classgrpc__impl_1_1_server.html">Server</a> *, const std::string &, <a class="el" href="classgrpc_1_1_server_credentials.html">grpc::ServerCredentials</a> *, int)</td></tr>
- <tr class="memdesc:ae1c370f5d884b638485675f996bae29a"><td class="mdescLeft"> </td><td class="mdescRight">Called after a server port is added. <a href="classgrpc__impl_1_1_server_1_1_global_callbacks.html#ae1c370f5d884b638485675f996bae29a">More...</a><br /></td></tr>
- <tr class="separator:ae1c370f5d884b638485675f996bae29a"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <div class="textblock"><p>Global callbacks are a set of hooks that are called when server events occur. </p>
- <p><em>SetGlobalCallbacks</em> method is used to register the hooks with gRPC. Note that the <em><a class="el" href="classgrpc__impl_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__impl_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>
- </div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
- <a id="a4b8e77bfae7312ffbcc66c4115e58e8c"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a4b8e77bfae7312ffbcc66c4115e58e8c">◆ </a></span>~GlobalCallbacks()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual grpc_impl::Server::GlobalCallbacks::~GlobalCallbacks </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <h2 class="groupheader">Member Function Documentation</h2>
- <a id="ae1c370f5d884b638485675f996bae29a"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ae1c370f5d884b638485675f996bae29a">◆ </a></span>AddPort()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void grpc_impl::Server::GlobalCallbacks::AddPort </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="classgrpc__impl_1_1_server.html">Server</a> * </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const std::string & </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="classgrpc_1_1_server_credentials.html">grpc::ServerCredentials</a> * </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int </td>
- <td class="paramname"> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Called after a server port is added. </p>
- </div>
- </div>
- <a id="ab881b0088cf1fa639d514d1dc3918334"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ab881b0088cf1fa639d514d1dc3918334">◆ </a></span>PostSynchronousRequest()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void grpc_impl::Server::GlobalCallbacks::PostSynchronousRequest </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="classgrpc__impl_1_1_server_context.html">grpc_impl::ServerContext</a> * </td>
- <td class="paramname"><em>context</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Called after application callback for each synchronous server request. </p>
- </div>
- </div>
- <a id="a54763e2c30add4fabb3bc62b18231d0b"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a54763e2c30add4fabb3bc62b18231d0b">◆ </a></span>PreServerStart()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void grpc_impl::Server::GlobalCallbacks::PreServerStart </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="classgrpc__impl_1_1_server.html">Server</a> * </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Called before server is started. </p>
- </div>
- </div>
- <a id="a3b8319323879d19bc9a4de5a4a744193"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a3b8319323879d19bc9a4de5a4a744193">◆ </a></span>PreSynchronousRequest()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void grpc_impl::Server::GlobalCallbacks::PreSynchronousRequest </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="classgrpc__impl_1_1_server_context.html">grpc_impl::ServerContext</a> * </td>
- <td class="paramname"><em>context</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Called before application callback for each synchronous server request. </p>
- </div>
- </div>
- <a id="a0e4e8960ad8f1cba761091a4e390fd0a"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a0e4e8960ad8f1cba761091a4e390fd0a">◆ </a></span>UpdateArguments()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void grpc_impl::Server::GlobalCallbacks::UpdateArguments </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="classgrpc_1_1_channel_arguments.html">grpc::ChannelArguments</a> * </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Called before server is created. </p>
- </div>
- </div>
- <hr/>The documentation for this class was generated from the following file:<ul>
- <li>include/grpcpp/<a class="el" href="server__impl_8h_source.html">server_impl.h</a></li>
- </ul>
- </div><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated on Sat Sep 12 2020 00:53:57 for GRPC C++ by  <a href="http://www.doxygen.org/index.html">
- <img class="footer" src="doxygen.png" alt="doxygen"/>
- </a> 1.8.17
- </small></address>
- </body>
- </html>
|