| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.11"/><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><script type="text/javascript">  $(document).ready(function() { init_search(); });</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.0.0</span>   </div>  </td> </tr> </tbody></table></div><!-- end header part --><!-- Generated by Doxygen 1.8.11 --><script type="text/javascript">var searchBox = new SearchBox("searchBox", "search",false,'Search');</script>  <div id="navrow1" class="tabs">    <ul class="tablist">      <li><a href="index.html"><span>Main Page</span></a></li>      <li><a href="modules.html"><span>Modules</span></a></li>      <li><a href="namespaces.html"><span>Namespaces</span></a></li>      <li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>      <li><a href="files.html"><span>Files</span></a></li>      <li>        <div id="MSearchBox" class="MSearchBoxInactive">        <span class="left">          <img id="MSearchSelect" src="search/mag_sel.png"               onmouseover="return searchBox.OnSearchSelectShow()"               onmouseout="return searchBox.OnSearchSelectHide()"               alt=""/>          <input type="text" id="MSearchField" value="Search" accesskey="S"               onfocus="searchBox.OnSearchFieldFocus(true)"                onblur="searchBox.OnSearchFieldFocus(false)"                onkeyup="searchBox.OnSearchFieldChange(event)"/>          </span><span class="right">            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>          </span>        </div>      </li>    </ul>  </div>  <div id="navrow2" class="tabs2">    <ul class="tablist">      <li><a href="annotated.html"><span>Data Structures</span></a></li>      <li><a href="classes.html"><span>Data Structure Index</span></a></li>      <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>      <li><a href="functions.html"><span>Data Fields</span></a></li>    </ul>  </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="#friends">Friends</a>  </div>  <div class="headertitle"><div class="title">grpc::Server Class Reference</div>  </div></div><!--header--><div class="contents"><p>Models a gRPC server.   <a href="classgrpc_1_1_server.html#details">More...</a></p><p><code>#include <<a class="el" href="server_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_1_global_callbacks.html">GlobalCallbacks</a></td></tr><tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Global Callbacks.  <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:aa13591ff1bb2c5d871778189b391feb2"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server.html#aa13591ff1bb2c5d871778189b391feb2">~Server</a> ()</td></tr><tr class="separator:aa13591ff1bb2c5d871778189b391feb2"><td class="memSeparator" colspan="2"> </td></tr><tr class="memitem:a298f4e18900e7083eb73c64168f1f324"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server.html#a298f4e18900e7083eb73c64168f1f324">Wait</a> () <a class="el" href="impl_2codegen_2config_8h.html#a9a884d706be26697c9c892365a3402a9">GRPC_OVERRIDE</a></td></tr><tr class="memdesc:a298f4e18900e7083eb73c64168f1f324"><td class="mdescLeft"> </td><td class="mdescRight">Block waiting for all work to complete.  <a href="#a298f4e18900e7083eb73c64168f1f324">More...</a><br /></td></tr><tr class="separator:a298f4e18900e7083eb73c64168f1f324"><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="separator:a7ff9f4e7ef7d51747dc362dcae9483fd"><td class="memSeparator" colspan="2"> </td></tr><tr class="memitem:a35d7499070bbe158e7f34b0bd5d58270"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_completion_queue.html">CompletionQueue</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server.html#a35d7499070bbe158e7f34b0bd5d58270">completion_queue</a> ()</td></tr><tr class="separator:a35d7499070bbe158e7f34b0bd5d58270"><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:a9908106bf62f6146eedbfa0dcce21b1a inherit pub_methods_classgrpc_1_1_server_interface"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_interface.html#a9908106bf62f6146eedbfa0dcce21b1a">~ServerInterface</a> ()</td></tr><tr class="separator:a9908106bf62f6146eedbfa0dcce21b1a 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">Shutdown the server, blocking until all rpc processing finishes.  <a href="#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, waiting for all rpc processing to finish.  <a href="#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_1_call_hook"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgrpc_1_1_call_hook')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classgrpc_1_1_call_hook.html">grpc::CallHook</a></td></tr><tr class="memitem:a4aa1cf199f80f6475c6da0ad679c5d9d inherit pub_methods_classgrpc_1_1_call_hook"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_call_hook.html#a4aa1cf199f80f6475c6da0ad679c5d9d">~CallHook</a> ()</td></tr><tr class="separator:a4aa1cf199f80f6475c6da0ad679c5d9d inherit pub_methods_classgrpc_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="#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="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><table class="memberdecls"><tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>Additional Inherited Members</h2></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:a021b10549db0d0ae7a4c8fedbdc003fe inherit pro_methods_classgrpc_1_1_server_interface"><td class="memTemplParams" colspan="2">template<class Message > </td></tr><tr class="memitem:a021b10549db0d0ae7a4c8fedbdc003fe 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#a021b10549db0d0ae7a4c8fedbdc003fe">RequestAsyncCall</a> (<a class="el" href="classgrpc_1_1_rpc_service_method.html">RpcServiceMethod</a> *method, <a class="el" href="classgrpc_1_1_server_context.html">ServerContext</a> *context, <a class="el" href="classgrpc_1_1_server_async_streaming_interface.html">ServerAsyncStreamingInterface</a> *stream, <a class="el" href="classgrpc_1_1_completion_queue.html">CompletionQueue</a> *call_cq, <a class="el" href="classgrpc_1_1_server_completion_queue.html">ServerCompletionQueue</a> *notification_cq, void *tag, Message *message)</td></tr><tr class="separator:a021b10549db0d0ae7a4c8fedbdc003fe inherit pro_methods_classgrpc_1_1_server_interface"><td class="memSeparator" colspan="2"> </td></tr><tr class="memitem:a40c1070113c5c6edfeb95dc835a3a996 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#a40c1070113c5c6edfeb95dc835a3a996">RequestAsyncCall</a> (<a class="el" href="classgrpc_1_1_rpc_service_method.html">RpcServiceMethod</a> *method, <a class="el" href="classgrpc_1_1_server_context.html">ServerContext</a> *context, <a class="el" href="classgrpc_1_1_server_async_streaming_interface.html">ServerAsyncStreamingInterface</a> *stream, <a class="el" href="classgrpc_1_1_completion_queue.html">CompletionQueue</a> *call_cq, <a class="el" href="classgrpc_1_1_server_completion_queue.html">ServerCompletionQueue</a> *notification_cq, void *tag)</td></tr><tr class="separator:a40c1070113c5c6edfeb95dc835a3a996 inherit pro_methods_classgrpc_1_1_server_interface"><td class="memSeparator" colspan="2"> </td></tr><tr class="memitem:abee9c5991c49712bfe329a4d72ef9590 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#abee9c5991c49712bfe329a4d72ef9590">RequestAsyncGenericCall</a> (<a class="el" href="classgrpc_1_1_generic_server_context.html">GenericServerContext</a> *context, <a class="el" href="classgrpc_1_1_server_async_streaming_interface.html">ServerAsyncStreamingInterface</a> *stream, <a class="el" href="classgrpc_1_1_completion_queue.html">CompletionQueue</a> *call_cq, <a class="el" href="classgrpc_1_1_server_completion_queue.html">ServerCompletionQueue</a> *notification_cq, void *tag)</td></tr><tr class="separator:abee9c5991c49712bfe329a4d72ef9590 inherit pro_methods_classgrpc_1_1_server_interface"><td class="memSeparator" colspan="2"> </td></tr></table><a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2><div class="textblock"><p>Models a gRPC server. </p><p>Servers are configured and started via <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>. </p></div><h2 class="groupheader">Constructor & Destructor Documentation</h2><a class="anchor" id="aa13591ff1bb2c5d871778189b391feb2"></a><div class="memitem"><div class="memproto">      <table class="memname">        <tr>          <td class="memname">grpc::Server::~Server </td>          <td>(</td>          <td class="paramname"></td><td>)</td>          <td></td>        </tr>      </table></div><div class="memdoc"></div></div><h2 class="groupheader">Member Function Documentation</h2><a class="anchor" id="a7ff9f4e7ef7d51747dc362dcae9483fd"></a><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"></div></div><a class="anchor" id="a35d7499070bbe158e7f34b0bd5d58270"></a><div class="memitem"><div class="memproto">      <table class="memname">        <tr>          <td class="memname"><a class="el" href="classgrpc_1_1_completion_queue.html">CompletionQueue</a>* grpc::Server::completion_queue </td>          <td>(</td>          <td class="paramname"></td><td>)</td>          <td></td>        </tr>      </table></div><div class="memdoc"></div></div><a class="anchor" id="a929329bdc505ebb7968132b2c34ffc78"></a><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. 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. </p></div></div><a class="anchor" id="a298f4e18900e7083eb73c64168f1f324"></a><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">virtual</span></span>  </td>  </tr></table></div><div class="memdoc"><p>Block waiting for all work to complete. </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 class="anchor" id="afa12bc5912105e1966887391881de595"></a><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 class="anchor" id="a8c2db91f514d534f06396d90c1b1f2c4"></a><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 class="anchor" id="a3531f118e1eafdfb790596dad66c8ed9"></a><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/grpc++/<a class="el" href="server_8h_source.html">server.h</a></li></ul></div><!-- contents --><!-- start footer part --><hr class="footer"/><address class="footer"><small>Generated on Thu Aug 18 2016 21:34:58 for GRPC C++ by  <a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11</small></address></body></html>
 |