| <!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::Server 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.71.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.html">grpc</a></li><li class="navelem"><a class="el" href="classgrpc_1_1_server.html">Server</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#nested-classes">Data Structures</a> | |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-static-methods">Static Public Member Functions</a> | |
| <a href="#pro-methods">Protected Member Functions</a> | |
| <a href="#friends">Friends</a> </div> |
| <div class="headertitle"> |
| <div class="title">grpc::Server Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Represents a gRPC server. |
| <a href="classgrpc_1_1_server.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="grpcpp_2server_8h_source.html">server.h</a>></code></p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> |
| Data Structures</h2></td></tr> |
| <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_1_1experimental__type.html">experimental_type</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">NOTE: class <a class="el" href="classgrpc_1_1_server_1_1experimental__type.html" title="NOTE: class experimental_type is not part of the public API of this class.">experimental_type</a> is not part of the public API of this class. <a href="classgrpc_1_1_server_1_1experimental__type.html#details">More...</a><br /></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_1_1_global_callbacks.html">GlobalCallbacks</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Global callbacks are a set of hooks that are called when server events occur. <a href="classgrpc_1_1_server_1_1_global_callbacks.html#details">More...</a><br /></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><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:a4745b387f1834b1eb08b1132199af615"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server.html#a4745b387f1834b1eb08b1132199af615">~Server</a> () ABSL_LOCKS_EXCLUDED(mu_) override</td></tr> |
| <tr class="separator:a4745b387f1834b1eb08b1132199af615"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a009682cfb2c453839b9eab318bbb8222"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server.html#a009682cfb2c453839b9eab318bbb8222">Wait</a> () ABSL_LOCKS_EXCLUDED(mu_) override</td></tr> |
| <tr class="memdesc:a009682cfb2c453839b9eab318bbb8222"><td class="mdescLeft"> </td><td class="mdescRight">Block until the server shuts down. <a href="classgrpc_1_1_server.html#a009682cfb2c453839b9eab318bbb8222">More...</a><br /></td></tr> |
| <tr class="separator:a009682cfb2c453839b9eab318bbb8222"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7ff9f4e7ef7d51747dc362dcae9483fd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="grpc__types_8h.html#a2bbbaad8f7a806f6c834b68c5dd916d8">grpc_server</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server.html#a7ff9f4e7ef7d51747dc362dcae9483fd">c_server</a> ()</td></tr> |
| <tr class="memdesc:a7ff9f4e7ef7d51747dc362dcae9483fd"><td class="mdescLeft"> </td><td class="mdescRight">Returns a <em>raw</em> pointer to the underlying <em>grpc_server</em> instance. <a href="classgrpc_1_1_server.html#a7ff9f4e7ef7d51747dc362dcae9483fd">More...</a><br /></td></tr> |
| <tr class="separator:a7ff9f4e7ef7d51747dc362dcae9483fd"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8ca33dab1210bf57468e44d000b138ee"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_health_check_service_interface.html">HealthCheckServiceInterface</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server.html#a8ca33dab1210bf57468e44d000b138ee">GetHealthCheckService</a> () const</td></tr> |
| <tr class="memdesc:a8ca33dab1210bf57468e44d000b138ee"><td class="mdescLeft"> </td><td class="mdescRight">Returns the health check service. <a href="classgrpc_1_1_server.html#a8ca33dab1210bf57468e44d000b138ee">More...</a><br /></td></tr> |
| <tr class="separator:a8ca33dab1210bf57468e44d000b138ee"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad48818dac08e28a2ea3694d1f5462c6b"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classgrpc_1_1_channel.html">Channel</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server.html#ad48818dac08e28a2ea3694d1f5462c6b">InProcessChannel</a> (const <a class="el" href="classgrpc_1_1_channel_arguments.html">ChannelArguments</a> &args)</td></tr> |
| <tr class="memdesc:ad48818dac08e28a2ea3694d1f5462c6b"><td class="mdescLeft"> </td><td class="mdescRight">Establish a channel for in-process communication. <a href="classgrpc_1_1_server.html#ad48818dac08e28a2ea3694d1f5462c6b">More...</a><br /></td></tr> |
| <tr class="separator:ad48818dac08e28a2ea3694d1f5462c6b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a19e2240f62b8ed2522beea7dffa11934"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_server_1_1experimental__type.html">experimental_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server.html#a19e2240f62b8ed2522beea7dffa11934">experimental</a> ()</td></tr> |
| <tr class="memdesc:a19e2240f62b8ed2522beea7dffa11934"><td class="mdescLeft"> </td><td class="mdescRight">NOTE: The function <a class="el" href="classgrpc_1_1_server.html#a19e2240f62b8ed2522beea7dffa11934" title="NOTE: The function experimental() is not stable public API.">experimental()</a> is not stable public API. <a href="classgrpc_1_1_server.html#a19e2240f62b8ed2522beea7dffa11934">More...</a><br /></td></tr> |
| <tr class="separator:a19e2240f62b8ed2522beea7dffa11934"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pub_methods_classgrpc_1_1_server_interface"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgrpc_1_1_server_interface')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classgrpc_1_1_server_interface.html">grpc::ServerInterface</a></td></tr> |
| <tr class="memitem:a5a0d58f2ecd8c878cde5f8cfd9d8a3e5 inherit pub_methods_classgrpc_1_1_server_interface"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_interface.html#a5a0d58f2ecd8c878cde5f8cfd9d8a3e5">~ServerInterface</a> () override</td></tr> |
| <tr class="separator:a5a0d58f2ecd8c878cde5f8cfd9d8a3e5 inherit pub_methods_classgrpc_1_1_server_interface"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a644772d11101318f1424e595dee73ccf inherit pub_methods_classgrpc_1_1_server_interface"><td class="memTemplParams" colspan="2">template<class T > </td></tr> |
| <tr class="memitem:a644772d11101318f1424e595dee73ccf inherit pub_methods_classgrpc_1_1_server_interface"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_interface.html#a644772d11101318f1424e595dee73ccf">Shutdown</a> (const T &deadline)</td></tr> |
| <tr class="memdesc:a644772d11101318f1424e595dee73ccf inherit pub_methods_classgrpc_1_1_server_interface"><td class="mdescLeft"> </td><td class="mdescRight"><em>Shutdown</em> does the following things: <a href="classgrpc_1_1_server_interface.html#a644772d11101318f1424e595dee73ccf">More...</a><br /></td></tr> |
| <tr class="separator:a644772d11101318f1424e595dee73ccf inherit pub_methods_classgrpc_1_1_server_interface"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6a1d337270116c95f387e0abf01f6c6c inherit pub_methods_classgrpc_1_1_server_interface"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_interface.html#a6a1d337270116c95f387e0abf01f6c6c">Shutdown</a> ()</td></tr> |
| <tr class="memdesc:a6a1d337270116c95f387e0abf01f6c6c inherit pub_methods_classgrpc_1_1_server_interface"><td class="mdescLeft"> </td><td class="mdescRight">Shutdown the server without a deadline and forced cancellation. <a href="classgrpc_1_1_server_interface.html#a6a1d337270116c95f387e0abf01f6c6c">More...</a><br /></td></tr> |
| <tr class="separator:a6a1d337270116c95f387e0abf01f6c6c inherit pub_methods_classgrpc_1_1_server_interface"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pub_methods_classgrpc_1_1internal_1_1_call_hook"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgrpc_1_1internal_1_1_call_hook')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classgrpc_1_1internal_1_1_call_hook.html">grpc::internal::CallHook</a></td></tr> |
| <tr class="memitem:a351f3060b7d6378dabcec53d21842487 inherit pub_methods_classgrpc_1_1internal_1_1_call_hook"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_call_hook.html#a351f3060b7d6378dabcec53d21842487">~CallHook</a> ()</td></tr> |
| <tr class="separator:a351f3060b7d6378dabcec53d21842487 inherit pub_methods_classgrpc_1_1internal_1_1_call_hook"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> |
| Static Public Member Functions</h2></td></tr> |
| <tr class="memitem:a929329bdc505ebb7968132b2c34ffc78"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server.html#a929329bdc505ebb7968132b2c34ffc78">SetGlobalCallbacks</a> (<a class="el" href="classgrpc_1_1_server_1_1_global_callbacks.html">GlobalCallbacks</a> *callbacks)</td></tr> |
| <tr class="memdesc:a929329bdc505ebb7968132b2c34ffc78"><td class="mdescLeft"> </td><td class="mdescRight">Set the global callback object. <a href="classgrpc_1_1_server.html#a929329bdc505ebb7968132b2c34ffc78">More...</a><br /></td></tr> |
| <tr class="separator:a929329bdc505ebb7968132b2c34ffc78"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a> |
| Protected Member Functions</h2></td></tr> |
| <tr class="memitem:a8fb988b3ce08eef46c059b2ba84b721d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server.html#a8fb988b3ce08eef46c059b2ba84b721d">RegisterService</a> (const std::string *addr, <a class="el" href="classgrpc_1_1_service.html">Service</a> *service) override</td></tr> |
| <tr class="memdesc:a8fb988b3ce08eef46c059b2ba84b721d"><td class="mdescLeft"> </td><td class="mdescRight">Register a service. <a href="classgrpc_1_1_server.html#a8fb988b3ce08eef46c059b2ba84b721d">More...</a><br /></td></tr> |
| <tr class="separator:a8fb988b3ce08eef46c059b2ba84b721d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3fb2f6e7339bd065f5c8069c21daf378"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server.html#a3fb2f6e7339bd065f5c8069c21daf378">AddListeningPort</a> (const std::string &addr, <a class="el" href="classgrpc_1_1_server_credentials.html">ServerCredentials</a> *creds) override</td></tr> |
| <tr class="memdesc:a3fb2f6e7339bd065f5c8069c21daf378"><td class="mdescLeft"> </td><td class="mdescRight">Try binding the server to the given <em>addr</em> endpoint (port, and optionally including IP address to bind to). <a href="classgrpc_1_1_server.html#a3fb2f6e7339bd065f5c8069c21daf378">More...</a><br /></td></tr> |
| <tr class="separator:a3fb2f6e7339bd065f5c8069c21daf378"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:adbcf7d0011e67368be717d2e8100dbaf"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server.html#adbcf7d0011e67368be717d2e8100dbaf">Server</a> (<a class="el" href="classgrpc_1_1_channel_arguments.html">ChannelArguments</a> *args, std::shared_ptr< std::vector< std::unique_ptr< <a class="el" href="classgrpc_1_1_server_completion_queue.html">ServerCompletionQueue</a> >>> sync_server_cqs, int min_pollers, int max_pollers, int sync_cq_timeout_msec, std::vector< std::shared_ptr< internal::ExternalConnectionAcceptorImpl >> acceptors, <a class="el" href="grpc_8h.html#a4c7dd742606d0ac388aff5cada9b14aa">grpc_server_config_fetcher</a> *server_config_fetcher=nullptr, <a class="el" href="grpc__types_8h.html#a16d58b8d7c93609d01311b869f4a8d05">grpc_resource_quota</a> *server_rq=nullptr, std::vector< std::unique_ptr< <a class="el" href="classgrpc_1_1experimental_1_1_server_interceptor_factory_interface.html">experimental::ServerInterceptorFactoryInterface</a> >> interceptor_creators=std::vector< std::unique_ptr< <a class="el" href="classgrpc_1_1experimental_1_1_server_interceptor_factory_interface.html">experimental::ServerInterceptorFactoryInterface</a> >>(), <a class="el" href="classgrpc_1_1experimental_1_1_server_metric_recorder.html">experimental::ServerMetricRecorder</a> *server_metric_recorder=nullptr)</td></tr> |
| <tr class="memdesc:adbcf7d0011e67368be717d2e8100dbaf"><td class="mdescLeft"> </td><td class="mdescRight">NOTE: This is <em>NOT</em> a public API. <a href="classgrpc_1_1_server.html#adbcf7d0011e67368be717d2e8100dbaf">More...</a><br /></td></tr> |
| <tr class="separator:adbcf7d0011e67368be717d2e8100dbaf"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:affff5d179b3a71617cbb02062f49eea4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server.html#affff5d179b3a71617cbb02062f49eea4">Start</a> (<a class="el" href="classgrpc_1_1_server_completion_queue.html">ServerCompletionQueue</a> **cqs, size_t num_cqs) override</td></tr> |
| <tr class="memdesc:affff5d179b3a71617cbb02062f49eea4"><td class="mdescLeft"> </td><td class="mdescRight">Start the server. <a href="classgrpc_1_1_server.html#affff5d179b3a71617cbb02062f49eea4">More...</a><br /></td></tr> |
| <tr class="separator:affff5d179b3a71617cbb02062f49eea4"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a01bdfb4554d12a10bdc9cf875ffa74dd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="grpc__types_8h.html#a2bbbaad8f7a806f6c834b68c5dd916d8">grpc_server</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server.html#a01bdfb4554d12a10bdc9cf875ffa74dd">server</a> () override</td></tr> |
| <tr class="separator:a01bdfb4554d12a10bdc9cf875ffa74dd"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:adf01b3e4829b2871502d78c1d6d63522"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server.html#adf01b3e4829b2871502d78c1d6d63522">set_health_check_service</a> (std::unique_ptr< <a class="el" href="classgrpc_1_1_health_check_service_interface.html">HealthCheckServiceInterface</a> > service)</td></tr> |
| <tr class="memdesc:adf01b3e4829b2871502d78c1d6d63522"><td class="mdescLeft"> </td><td class="mdescRight">NOTE: This method is not part of the public API for this class. <a href="classgrpc_1_1_server.html#adf01b3e4829b2871502d78c1d6d63522">More...</a><br /></td></tr> |
| <tr class="separator:adf01b3e4829b2871502d78c1d6d63522"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ace1254eaac4f93abfa7cd49c5b54f8f3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_context_allocator.html">ContextAllocator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server.html#ace1254eaac4f93abfa7cd49c5b54f8f3">context_allocator</a> ()</td></tr> |
| <tr class="separator:ace1254eaac4f93abfa7cd49c5b54f8f3"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a87eac30243473d7f788f3cfc85b7e83e"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server.html#a87eac30243473d7f788f3cfc85b7e83e">health_check_service_disabled</a> () const</td></tr> |
| <tr class="memdesc:a87eac30243473d7f788f3cfc85b7e83e"><td class="mdescLeft"> </td><td class="mdescRight">NOTE: This method is not part of the public API for this class. <a href="classgrpc_1_1_server.html#a87eac30243473d7f788f3cfc85b7e83e">More...</a><br /></td></tr> |
| <tr class="separator:a87eac30243473d7f788f3cfc85b7e83e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pro_methods_classgrpc_1_1_server_interface"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classgrpc_1_1_server_interface')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classgrpc_1_1_server_interface.html">grpc::ServerInterface</a></td></tr> |
| <tr class="memitem:a02f68c7b2a1751eeffcd13bf2177bdf6 inherit pro_methods_classgrpc_1_1_server_interface"><td class="memTemplParams" colspan="2">template<class Message > </td></tr> |
| <tr class="memitem:a02f68c7b2a1751eeffcd13bf2177bdf6 inherit pro_methods_classgrpc_1_1_server_interface"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_interface.html#a02f68c7b2a1751eeffcd13bf2177bdf6">RequestAsyncCall</a> (<a class="el" href="classgrpc_1_1internal_1_1_rpc_service_method.html">internal::RpcServiceMethod</a> *method, <a class="el" href="classgrpc_1_1_server_context.html">grpc::ServerContext</a> *context, <a class="el" href="classgrpc_1_1internal_1_1_server_async_streaming_interface.html">internal::ServerAsyncStreamingInterface</a> *stream, <a class="el" href="classgrpc_1_1_completion_queue.html">grpc::CompletionQueue</a> *call_cq, <a class="el" href="classgrpc_1_1_server_completion_queue.html">grpc::ServerCompletionQueue</a> *notification_cq, void *tag, Message *message)</td></tr> |
| <tr class="separator:a02f68c7b2a1751eeffcd13bf2177bdf6 inherit pro_methods_classgrpc_1_1_server_interface"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aac1c18aa8e81cf0048dd1faf8d3a67e4 inherit pro_methods_classgrpc_1_1_server_interface"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_interface.html#aac1c18aa8e81cf0048dd1faf8d3a67e4">RequestAsyncCall</a> (<a class="el" href="classgrpc_1_1internal_1_1_rpc_service_method.html">internal::RpcServiceMethod</a> *method, <a class="el" href="classgrpc_1_1_server_context.html">grpc::ServerContext</a> *context, <a class="el" href="classgrpc_1_1internal_1_1_server_async_streaming_interface.html">internal::ServerAsyncStreamingInterface</a> *stream, <a class="el" href="classgrpc_1_1_completion_queue.html">grpc::CompletionQueue</a> *call_cq, <a class="el" href="classgrpc_1_1_server_completion_queue.html">grpc::ServerCompletionQueue</a> *notification_cq, void *tag)</td></tr> |
| <tr class="separator:aac1c18aa8e81cf0048dd1faf8d3a67e4 inherit pro_methods_classgrpc_1_1_server_interface"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a67b51710e5e97414a6d8ab383c7254f2 inherit pro_methods_classgrpc_1_1_server_interface"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_interface.html#a67b51710e5e97414a6d8ab383c7254f2">RequestAsyncGenericCall</a> (<a class="el" href="classgrpc_1_1_generic_server_context.html">GenericServerContext</a> *context, <a class="el" href="classgrpc_1_1internal_1_1_server_async_streaming_interface.html">internal::ServerAsyncStreamingInterface</a> *stream, <a class="el" href="classgrpc_1_1_completion_queue.html">grpc::CompletionQueue</a> *call_cq, <a class="el" href="classgrpc_1_1_server_completion_queue.html">grpc::ServerCompletionQueue</a> *notification_cq, void *tag)</td></tr> |
| <tr class="separator:a67b51710e5e97414a6d8ab383c7254f2 inherit pro_methods_classgrpc_1_1_server_interface"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a> |
| Friends</h2></td></tr> |
| <tr class="memitem:afa12bc5912105e1966887391881de595"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server.html#afa12bc5912105e1966887391881de595">AsyncGenericService</a></td></tr> |
| <tr class="separator:afa12bc5912105e1966887391881de595"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8c2db91f514d534f06396d90c1b1f2c4"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server.html#a8c2db91f514d534f06396d90c1b1f2c4">ServerBuilder</a></td></tr> |
| <tr class="separator:a8c2db91f514d534f06396d90c1b1f2c4"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3531f118e1eafdfb790596dad66c8ed9"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server.html#a3531f118e1eafdfb790596dad66c8ed9">ServerInitializer</a></td></tr> |
| <tr class="separator:a3531f118e1eafdfb790596dad66c8ed9"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Represents a gRPC server. </p> |
| <p>Use a <em><a class="el" href="classgrpc_1_1_server_builder.html" title="A builder class for the creation and startup of grpc::Server instances.">grpc::ServerBuilder</a></em> to create, configure, and start <em><a class="el" href="classgrpc_1_1_server.html" title="Represents a gRPC server.">Server</a></em> instances. </p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a4745b387f1834b1eb08b1132199af615"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a4745b387f1834b1eb08b1132199af615">◆ </a></span>~Server()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">grpc::Server::~Server </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">override</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="adbcf7d0011e67368be717d2e8100dbaf"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#adbcf7d0011e67368be717d2e8100dbaf">◆ </a></span>Server()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">grpc::Server::Server </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classgrpc_1_1_channel_arguments.html">ChannelArguments</a> * </td> |
| <td class="paramname"><em>args</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">std::shared_ptr< std::vector< std::unique_ptr< <a class="el" href="classgrpc_1_1_server_completion_queue.html">ServerCompletionQueue</a> >>> </td> |
| <td class="paramname"><em>sync_server_cqs</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>min_pollers</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>max_pollers</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>sync_cq_timeout_msec</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">std::vector< std::shared_ptr< internal::ExternalConnectionAcceptorImpl >> </td> |
| <td class="paramname"><em>acceptors</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="grpc_8h.html#a4c7dd742606d0ac388aff5cada9b14aa">grpc_server_config_fetcher</a> * </td> |
| <td class="paramname"><em>server_config_fetcher</em> = <code>nullptr</code>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="grpc__types_8h.html#a16d58b8d7c93609d01311b869f4a8d05">grpc_resource_quota</a> * </td> |
| <td class="paramname"><em>server_rq</em> = <code>nullptr</code>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">std::vector< std::unique_ptr< <a class="el" href="classgrpc_1_1experimental_1_1_server_interceptor_factory_interface.html">experimental::ServerInterceptorFactoryInterface</a> >> </td> |
| <td class="paramname"><em>interceptor_creators</em> = <code>std::vector< std::unique_ptr< <a class="el" href="classgrpc_1_1experimental_1_1_server_interceptor_factory_interface.html">experimental::ServerInterceptorFactoryInterface</a> >>()</code>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="classgrpc_1_1experimental_1_1_server_metric_recorder.html">experimental::ServerMetricRecorder</a> * </td> |
| <td class="paramname"><em>server_metric_recorder</em> = <code>nullptr</code> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">protected</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>NOTE: This is <em>NOT</em> a public API. </p> |
| <p>The server constructors are supposed to be used by <em><a class="el" href="classgrpc_1_1_server_builder.html" title="A builder class for the creation and startup of grpc::Server instances.">ServerBuilder</a></em> class only. The constructor will be made 'private' very soon.</p> |
| <p><a class="el" href="classgrpc_1_1_server.html" title="Represents a gRPC server.">Server</a> constructors. To be used by <em><a class="el" href="classgrpc_1_1_server_builder.html" title="A builder class for the creation and startup of grpc::Server instances.">ServerBuilder</a></em> only.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">args</td><td>The channel args</td></tr> |
| <tr><td class="paramname">sync_server_cqs</td><td>The completion queues to use if the server is a synchronous server (or a hybrid server). The server polls for new RPCs on these queues</td></tr> |
| <tr><td class="paramname">min_pollers</td><td>The minimum number of polling threads per server completion queue (in param sync_server_cqs) to use for listening to incoming requests (used only in case of sync server)</td></tr> |
| <tr><td class="paramname">max_pollers</td><td>The maximum number of polling threads per server completion queue (in param sync_server_cqs) to use for listening to incoming requests (used only in case of sync server)</td></tr> |
| <tr><td class="paramname">sync_cq_timeout_msec</td><td>The timeout to use when calling AsyncNext() on server completion queues passed via sync_server_cqs param. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a3fb2f6e7339bd065f5c8069c21daf378"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a3fb2f6e7339bd065f5c8069c21daf378">◆ </a></span>AddListeningPort()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int grpc::Server::AddListeningPort </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>addr</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="classgrpc_1_1_server_credentials.html">ServerCredentials</a> * </td> |
| <td class="paramname"><em>creds</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Try binding the server to the given <em>addr</em> endpoint (port, and optionally including IP address to bind to). </p> |
| <p>It can be invoked multiple times. Should be used before starting the server.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">addr</td><td>The address to try to bind to the server (eg, localhost:1234, 192.168.1.1:31416, [::1]:27182, etc.). </td></tr> |
| <tr><td class="paramname">creds</td><td>The credentials associated with the server.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>bound port number on success, 0 on failure.</dd></dl> |
| <dl class="section warning"><dt>Warning</dt><dd>It is an error to call this method on an already started server. </dd></dl> |
| |
| <p>Implements <a class="el" href="classgrpc_1_1_server_interface.html#a416cf42ee17bdc3a4109f614610dad02">grpc::ServerInterface</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a7ff9f4e7ef7d51747dc362dcae9483fd"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a7ff9f4e7ef7d51747dc362dcae9483fd">◆ </a></span>c_server()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="grpc__types_8h.html#a2bbbaad8f7a806f6c834b68c5dd916d8">grpc_server</a>* grpc::Server::c_server </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns a <em>raw</em> pointer to the underlying <em>grpc_server</em> instance. </p> |
| <p>EXPERIMENTAL: for internal/test use only </p> |
| |
| </div> |
| </div> |
| <a id="ace1254eaac4f93abfa7cd49c5b54f8f3"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ace1254eaac4f93abfa7cd49c5b54f8f3">◆ </a></span>context_allocator()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classgrpc_1_1_context_allocator.html">ContextAllocator</a>* grpc::Server::context_allocator </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">protected</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="a19e2240f62b8ed2522beea7dffa11934"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a19e2240f62b8ed2522beea7dffa11934">◆ </a></span>experimental()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classgrpc_1_1_server_1_1experimental__type.html">experimental_type</a> grpc::Server::experimental </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> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>NOTE: The function <a class="el" href="classgrpc_1_1_server.html#a19e2240f62b8ed2522beea7dffa11934" title="NOTE: The function experimental() is not stable public API.">experimental()</a> is not stable public API. </p> |
| <p>It is a view to the experimental components of this class. It may be changed or removed at any time. </p> |
| |
| </div> |
| </div> |
| <a id="a8ca33dab1210bf57468e44d000b138ee"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a8ca33dab1210bf57468e44d000b138ee">◆ </a></span>GetHealthCheckService()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classgrpc_1_1_health_check_service_interface.html">HealthCheckServiceInterface</a>* grpc::Server::GetHealthCheckService </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns the health check service. </p> |
| |
| </div> |
| </div> |
| <a id="a87eac30243473d7f788f3cfc85b7e83e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a87eac30243473d7f788f3cfc85b7e83e">◆ </a></span>health_check_service_disabled()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool grpc::Server::health_check_service_disabled </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>NOTE: This method is not part of the public API for this class. </p> |
| |
| </div> |
| </div> |
| <a id="ad48818dac08e28a2ea3694d1f5462c6b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad48818dac08e28a2ea3694d1f5462c6b">◆ </a></span>InProcessChannel()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::shared_ptr<<a class="el" href="classgrpc_1_1_channel.html">Channel</a>> grpc::Server::InProcessChannel </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classgrpc_1_1_channel_arguments.html">ChannelArguments</a> & </td> |
| <td class="paramname"><em>args</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Establish a channel for in-process communication. </p> |
| |
| </div> |
| </div> |
| <a id="a8fb988b3ce08eef46c059b2ba84b721d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a8fb988b3ce08eef46c059b2ba84b721d">◆ </a></span>RegisterService()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool grpc::Server::RegisterService </td> |
| <td>(</td> |
| <td class="paramtype">const std::string * </td> |
| <td class="paramname"><em>addr</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="classgrpc_1_1_service.html">Service</a> * </td> |
| <td class="paramname"><em>service</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Register a service. </p> |
| <p>This call does not take ownership of the service. The service must exist for the lifetime of the <a class="el" href="classgrpc_1_1_server.html" title="Represents a gRPC server.">Server</a> instance. </p> |
| |
| <p>Implements <a class="el" href="classgrpc_1_1_server_interface.html#a340434ec348e1e8ed4fa2fb87f3194cc">grpc::ServerInterface</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a01bdfb4554d12a10bdc9cf875ffa74dd"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a01bdfb4554d12a10bdc9cf875ffa74dd">◆ </a></span>server()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="grpc__types_8h.html#a2bbbaad8f7a806f6c834b68c5dd916d8">grpc_server</a>* grpc::Server::server </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">override</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Implements <a class="el" href="classgrpc_1_1_server_interface.html#a8e9cf80377d3fd1f110089ad16ec79e7">grpc::ServerInterface</a>.</p> |
| |
| </div> |
| </div> |
| <a id="adf01b3e4829b2871502d78c1d6d63522"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#adf01b3e4829b2871502d78c1d6d63522">◆ </a></span>set_health_check_service()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void grpc::Server::set_health_check_service </td> |
| <td>(</td> |
| <td class="paramtype">std::unique_ptr< <a class="el" href="classgrpc_1_1_health_check_service_interface.html">HealthCheckServiceInterface</a> > </td> |
| <td class="paramname"><em>service</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>NOTE: This method is not part of the public API for this class. </p> |
| |
| </div> |
| </div> |
| <a id="a929329bdc505ebb7968132b2c34ffc78"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a929329bdc505ebb7968132b2c34ffc78">◆ </a></span>SetGlobalCallbacks()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static void grpc::Server::SetGlobalCallbacks </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classgrpc_1_1_server_1_1_global_callbacks.html">GlobalCallbacks</a> * </td> |
| <td class="paramname"><em>callbacks</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Set the global callback object. </p> |
| <p>Can only be called once per application. Does not take ownership of callbacks, and expects the pointed to object to be alive until all server objects in the process have been destroyed. The same <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> object will be used throughout the application and is shared among all <em><a class="el" href="classgrpc_1_1_server.html" title="Represents a gRPC server.">Server</a></em> objects. </p> |
| |
| </div> |
| </div> |
| <a id="affff5d179b3a71617cbb02062f49eea4"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#affff5d179b3a71617cbb02062f49eea4">◆ </a></span>Start()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void grpc::Server::Start </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classgrpc_1_1_server_completion_queue.html">ServerCompletionQueue</a> ** </td> |
| <td class="paramname"><em>cqs</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">size_t </td> |
| <td class="paramname"><em>num_cqs</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Start the server. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">cqs</td><td>Completion queues for handling asynchronous services. The caller is required to keep all completion queues live until the server is destroyed. </td></tr> |
| <tr><td class="paramname">num_cqs</td><td>How many completion queues does <em>cqs</em> hold. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Implements <a class="el" href="classgrpc_1_1_server_interface.html#a9100ddb5d1f3a893cf26b388f2961ec3">grpc::ServerInterface</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a009682cfb2c453839b9eab318bbb8222"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a009682cfb2c453839b9eab318bbb8222">◆ </a></span>Wait()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void grpc::Server::Wait </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Block until the server shuts down. </p> |
| <dl class="section warning"><dt>Warning</dt><dd>The server must be either shutting down or some other thread must call <em>Shutdown</em> for this function to ever return. </dd></dl> |
| |
| <p>Implements <a class="el" href="classgrpc_1_1_server_interface.html#ac36477b6a7593a4e4608c7eb712b0d70">grpc::ServerInterface</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Friends And Related Function Documentation</h2> |
| <a id="afa12bc5912105e1966887391881de595"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#afa12bc5912105e1966887391881de595">◆ </a></span>AsyncGenericService</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">friend class <a class="el" href="classgrpc_1_1_async_generic_service.html">AsyncGenericService</a></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">friend</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="a8c2db91f514d534f06396d90c1b1f2c4"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a8c2db91f514d534f06396d90c1b1f2c4">◆ </a></span>ServerBuilder</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">friend class <a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">friend</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="a3531f118e1eafdfb790596dad66c8ed9"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a3531f118e1eafdfb790596dad66c8ed9">◆ </a></span>ServerInitializer</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">friend class <a class="el" href="classgrpc_1_1_server_initializer.html">ServerInitializer</a></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">friend</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>include/grpcpp/<a class="el" href="grpcpp_2server_8h_source.html">server.h</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Mar 13 2025 18:13:56 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> |
