classgrpc_1_1_server_interface.html 41 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810
  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::ServerInterface 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">0.13.1-pre1</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="namespaces.html"><span>Namespaces</span></a></li>
  42. <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  43. <li><a href="files.html"><span>Files</span></a></li>
  44. <li>
  45. <div id="MSearchBox" class="MSearchBoxInactive">
  46. <span class="left">
  47. <img id="MSearchSelect" src="search/mag_sel.png"
  48. onmouseover="return searchBox.OnSearchSelectShow()"
  49. onmouseout="return searchBox.OnSearchSelectHide()"
  50. alt=""/>
  51. <input type="text" id="MSearchField" value="Search" accesskey="S"
  52. onfocus="searchBox.OnSearchFieldFocus(true)"
  53. onblur="searchBox.OnSearchFieldFocus(false)"
  54. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  55. </span><span class="right">
  56. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  57. </span>
  58. </div>
  59. </li>
  60. </ul>
  61. </div>
  62. <div id="navrow2" class="tabs2">
  63. <ul class="tablist">
  64. <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  65. <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
  66. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  67. <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
  68. </ul>
  69. </div>
  70. <!-- window showing the filter options -->
  71. <div id="MSearchSelectWindow"
  72. onmouseover="return searchBox.OnSearchSelectShow()"
  73. onmouseout="return searchBox.OnSearchSelectHide()"
  74. onkeydown="return searchBox.OnSearchSelectKey(event)">
  75. <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>Pages</a></div>
  76. <!-- iframe showing the search results (closed by default) -->
  77. <div id="MSearchResultsWindow">
  78. <iframe src="javascript:void(0)" frameborder="0"
  79. name="MSearchResults" id="MSearchResults">
  80. </iframe>
  81. </div>
  82. <div id="nav-path" class="navpath">
  83. <ul>
  84. <li class="navelem"><a class="el" href="namespacegrpc.html">grpc</a></li><li class="navelem"><a class="el" href="classgrpc_1_1_server_interface.html">ServerInterface</a></li> </ul>
  85. </div>
  86. </div><!-- top -->
  87. <div class="header">
  88. <div class="summary">
  89. <a href="#nested-classes">Data Structures</a> &#124;
  90. <a href="#pub-methods">Public Member Functions</a> &#124;
  91. <a href="#pro-methods">Protected Member Functions</a> &#124;
  92. <a href="#friends">Friends</a> </div>
  93. <div class="headertitle">
  94. <div class="title">grpc::ServerInterface Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
  95. </div><!--header-->
  96. <div class="contents">
  97. <p>Models a gRPC server.
  98. <a href="classgrpc_1_1_server_interface.html#details">More...</a></p>
  99. <p><code>#include &lt;<a class="el" href="server__interface_8h_source.html">server_interface.h</a>&gt;</code></p>
  100. <table class="memberdecls">
  101. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  102. Data Structures</h2></td></tr>
  103. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_interface_1_1_base_async_request.html">BaseAsyncRequest</a></td></tr>
  104. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_interface_1_1_generic_async_request.html">GenericAsyncRequest</a></td></tr>
  106. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_interface_1_1_no_payload_async_request.html">NoPayloadAsyncRequest</a></td></tr>
  108. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_interface_1_1_payload_async_request.html">PayloadAsyncRequest</a></td></tr>
  110. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_interface_1_1_registered_async_request.html">RegisteredAsyncRequest</a></td></tr>
  112. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. </table><table class="memberdecls">
  114. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  115. Public Member Functions</h2></td></tr>
  116. <tr class="memitem:a9908106bf62f6146eedbfa0dcce21b1a"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_interface.html#a9908106bf62f6146eedbfa0dcce21b1a">~ServerInterface</a> ()</td></tr>
  117. <tr class="separator:a9908106bf62f6146eedbfa0dcce21b1a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <tr class="memitem:a644772d11101318f1424e595dee73ccf"><td class="memTemplParams" colspan="2">template&lt;class T &gt; </td></tr>
  119. <tr class="memitem:a644772d11101318f1424e595dee73ccf"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_interface.html#a644772d11101318f1424e595dee73ccf">Shutdown</a> (const T &amp;deadline)</td></tr>
  120. <tr class="memdesc:a644772d11101318f1424e595dee73ccf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Shutdown the server, blocking until all rpc processing finishes. <a href="#a644772d11101318f1424e595dee73ccf">More...</a><br/></td></tr>
  121. <tr class="separator:a644772d11101318f1424e595dee73ccf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="memitem:a6a1d337270116c95f387e0abf01f6c6c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_interface.html#a6a1d337270116c95f387e0abf01f6c6c">Shutdown</a> ()</td></tr>
  123. <tr class="memdesc:a6a1d337270116c95f387e0abf01f6c6c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Shutdown the server, waiting for all rpc processing to finish. <a href="#a6a1d337270116c95f387e0abf01f6c6c">More...</a><br/></td></tr>
  124. <tr class="separator:a6a1d337270116c95f387e0abf01f6c6c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <tr class="memitem:ac36477b6a7593a4e4608c7eb712b0d70"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_interface.html#ac36477b6a7593a4e4608c7eb712b0d70">Wait</a> ()=0</td></tr>
  126. <tr class="memdesc:ac36477b6a7593a4e4608c7eb712b0d70"><td class="mdescLeft">&#160;</td><td class="mdescRight">Block waiting for all work to complete. <a href="#ac36477b6a7593a4e4608c7eb712b0d70">More...</a><br/></td></tr>
  127. <tr class="separator:ac36477b6a7593a4e4608c7eb712b0d70"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <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="-"/>&#160;Public Member Functions inherited from <a class="el" href="classgrpc_1_1_call_hook.html">grpc::CallHook</a></td></tr>
  129. <tr class="memitem:a4aa1cf199f80f6475c6da0ad679c5d9d inherit pub_methods_classgrpc_1_1_call_hook"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_call_hook.html#a4aa1cf199f80f6475c6da0ad679c5d9d">~CallHook</a> ()</td></tr>
  130. <tr class="separator:a4aa1cf199f80f6475c6da0ad679c5d9d inherit pub_methods_classgrpc_1_1_call_hook"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. </table><table class="memberdecls">
  132. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
  133. Protected Member Functions</h2></td></tr>
  134. <tr class="memitem:af51988df89cdcc8ad7b0b1d528717dad"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_interface.html#af51988df89cdcc8ad7b0b1d528717dad">RegisterService</a> (const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> *host, <a class="el" href="classgrpc_1_1_service.html">Service</a> *service)=0</td></tr>
  135. <tr class="memdesc:af51988df89cdcc8ad7b0b1d528717dad"><td class="mdescLeft">&#160;</td><td class="mdescRight">Register a service. <a href="#af51988df89cdcc8ad7b0b1d528717dad">More...</a><br/></td></tr>
  136. <tr class="separator:af51988df89cdcc8ad7b0b1d528717dad"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <tr class="memitem:adaddf784fcb65fca743b04e1803f72ae"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_interface.html#adaddf784fcb65fca743b04e1803f72ae">RegisterAsyncGenericService</a> (<a class="el" href="classgrpc_1_1_async_generic_service.html">AsyncGenericService</a> *service)=0</td></tr>
  138. <tr class="memdesc:adaddf784fcb65fca743b04e1803f72ae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Register a generic service. <a href="#adaddf784fcb65fca743b04e1803f72ae">More...</a><br/></td></tr>
  139. <tr class="separator:adaddf784fcb65fca743b04e1803f72ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <tr class="memitem:ae3716834f7d4aec1883e36e99c9c5123"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_interface.html#ae3716834f7d4aec1883e36e99c9c5123">AddListeningPort</a> (const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;addr, <a class="el" href="classgrpc_1_1_server_credentials.html">ServerCredentials</a> *creds)=0</td></tr>
  141. <tr class="memdesc:ae3716834f7d4aec1883e36e99c9c5123"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tries to bind <em>server</em> to the given <em>addr</em>. <a href="#ae3716834f7d4aec1883e36e99c9c5123">More...</a><br/></td></tr>
  142. <tr class="separator:ae3716834f7d4aec1883e36e99c9c5123"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <tr class="memitem:aa0bd69382b7e6d35e34190d4faefa039"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_interface.html#aa0bd69382b7e6d35e34190d4faefa039">Start</a> (<a class="el" href="classgrpc_1_1_server_completion_queue.html">ServerCompletionQueue</a> **cqs, size_t num_cqs)=0</td></tr>
  144. <tr class="memdesc:aa0bd69382b7e6d35e34190d4faefa039"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start the server. <a href="#aa0bd69382b7e6d35e34190d4faefa039">More...</a><br/></td></tr>
  145. <tr class="separator:aa0bd69382b7e6d35e34190d4faefa039"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. <tr class="memitem:a0026d00c08dca06277a5bc5acf3a9c1f"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_interface.html#a0026d00c08dca06277a5bc5acf3a9c1f">RunRpc</a> ()=0</td></tr>
  147. <tr class="memdesc:a0026d00c08dca06277a5bc5acf3a9c1f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Process one or more incoming calls. <a href="#a0026d00c08dca06277a5bc5acf3a9c1f">More...</a><br/></td></tr>
  148. <tr class="separator:a0026d00c08dca06277a5bc5acf3a9c1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  149. <tr class="memitem:a0e95f7753d8569fe645b20104c20cef8"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_interface.html#a0e95f7753d8569fe645b20104c20cef8">ScheduleCallback</a> ()=0</td></tr>
  150. <tr class="memdesc:a0e95f7753d8569fe645b20104c20cef8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Schedule <em>RunRpc</em> to run in the threadpool. <a href="#a0e95f7753d8569fe645b20104c20cef8">More...</a><br/></td></tr>
  151. <tr class="separator:a0e95f7753d8569fe645b20104c20cef8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  152. <tr class="memitem:a862fd9a2d64e66447d41d0aba40af2f9"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_interface.html#a862fd9a2d64e66447d41d0aba40af2f9">ShutdownInternal</a> (gpr_timespec deadline)=0</td></tr>
  153. <tr class="separator:a862fd9a2d64e66447d41d0aba40af2f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  154. <tr class="memitem:ae11096e9d961e3cc2059b71ed39f68be"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_interface.html#ae11096e9d961e3cc2059b71ed39f68be">max_message_size</a> () const =0</td></tr>
  155. <tr class="separator:ae11096e9d961e3cc2059b71ed39f68be"><td class="memSeparator" colspan="2">&#160;</td></tr>
  156. <tr class="memitem:a8e9cf80377d3fd1f110089ad16ec79e7"><td class="memItemLeft" align="right" valign="top">virtual grpc_server *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_interface.html#a8e9cf80377d3fd1f110089ad16ec79e7">server</a> ()=0</td></tr>
  157. <tr class="separator:a8e9cf80377d3fd1f110089ad16ec79e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  158. <tr class="memitem:a16320b2185bda0965e51a73bf0fb9472"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_interface.html#a16320b2185bda0965e51a73bf0fb9472">PerformOpsOnCall</a> (<a class="el" href="classgrpc_1_1_call_op_set_interface.html">CallOpSetInterface</a> *ops, <a class="el" href="classgrpc_1_1_call.html">Call</a> *call)=0</td></tr>
  159. <tr class="separator:a16320b2185bda0965e51a73bf0fb9472"><td class="memSeparator" colspan="2">&#160;</td></tr>
  160. <tr class="memitem:a021b10549db0d0ae7a4c8fedbdc003fe"><td class="memTemplParams" colspan="2">template&lt;class Message &gt; </td></tr>
  161. <tr class="memitem:a021b10549db0d0ae7a4c8fedbdc003fe"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</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>
  162. <tr class="separator:a021b10549db0d0ae7a4c8fedbdc003fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
  163. <tr class="memitem:a40c1070113c5c6edfeb95dc835a3a996"><td class="memItemLeft" align="right" valign="top">void&#160;</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>
  164. <tr class="separator:a40c1070113c5c6edfeb95dc835a3a996"><td class="memSeparator" colspan="2">&#160;</td></tr>
  165. <tr class="memitem:abee9c5991c49712bfe329a4d72ef9590"><td class="memItemLeft" align="right" valign="top">void&#160;</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>
  166. <tr class="separator:abee9c5991c49712bfe329a4d72ef9590"><td class="memSeparator" colspan="2">&#160;</td></tr>
  167. </table><table class="memberdecls">
  168. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
  169. Friends</h2></td></tr>
  170. <tr class="memitem:a6474ceb8669761e879329b39c3afb899"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_interface.html#a6474ceb8669761e879329b39c3afb899">Service</a></td></tr>
  171. <tr class="separator:a6474ceb8669761e879329b39c3afb899"><td class="memSeparator" colspan="2">&#160;</td></tr>
  172. </table>
  173. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  174. <div class="textblock"><p>Models a gRPC server. </p>
  175. <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>
  176. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  177. <a class="anchor" id="a9908106bf62f6146eedbfa0dcce21b1a"></a>
  178. <div class="memitem">
  179. <div class="memproto">
  180. <table class="mlabels">
  181. <tr>
  182. <td class="mlabels-left">
  183. <table class="memname">
  184. <tr>
  185. <td class="memname">virtual grpc::ServerInterface::~ServerInterface </td>
  186. <td>(</td>
  187. <td class="paramname"></td><td>)</td>
  188. <td></td>
  189. </tr>
  190. </table>
  191. </td>
  192. <td class="mlabels-right">
  193. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
  194. </tr>
  195. </table>
  196. </div><div class="memdoc">
  197. </div>
  198. </div>
  199. <h2 class="groupheader">Member Function Documentation</h2>
  200. <a class="anchor" id="ae3716834f7d4aec1883e36e99c9c5123"></a>
  201. <div class="memitem">
  202. <div class="memproto">
  203. <table class="mlabels">
  204. <tr>
  205. <td class="mlabels-left">
  206. <table class="memname">
  207. <tr>
  208. <td class="memname">virtual int grpc::ServerInterface::AddListeningPort </td>
  209. <td>(</td>
  210. <td class="paramtype">const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;&#160;</td>
  211. <td class="paramname"><em>addr</em>, </td>
  212. </tr>
  213. <tr>
  214. <td class="paramkey"></td>
  215. <td></td>
  216. <td class="paramtype"><a class="el" href="classgrpc_1_1_server_credentials.html">ServerCredentials</a> *&#160;</td>
  217. <td class="paramname"><em>creds</em>&#160;</td>
  218. </tr>
  219. <tr>
  220. <td></td>
  221. <td>)</td>
  222. <td></td><td></td>
  223. </tr>
  224. </table>
  225. </td>
  226. <td class="mlabels-right">
  227. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span> </td>
  228. </tr>
  229. </table>
  230. </div><div class="memdoc">
  231. <p>Tries to bind <em>server</em> to the given <em>addr</em>. </p>
  232. <p>It can be invoked multiple times.</p>
  233. <dl class="params"><dt>Parameters</dt><dd>
  234. <table class="params">
  235. <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.). creds The credentials associated with the server.</td></tr>
  236. </table>
  237. </dd>
  238. </dl>
  239. <dl class="section return"><dt>Returns</dt><dd>bound port number on sucess, 0 on failure.</dd></dl>
  240. <dl class="section warning"><dt>Warning</dt><dd>It's an error to call this method on an already started server. </dd></dl>
  241. </div>
  242. </div>
  243. <a class="anchor" id="ae11096e9d961e3cc2059b71ed39f68be"></a>
  244. <div class="memitem">
  245. <div class="memproto">
  246. <table class="mlabels">
  247. <tr>
  248. <td class="mlabels-left">
  249. <table class="memname">
  250. <tr>
  251. <td class="memname">virtual int grpc::ServerInterface::max_message_size </td>
  252. <td>(</td>
  253. <td class="paramname"></td><td>)</td>
  254. <td> const</td>
  255. </tr>
  256. </table>
  257. </td>
  258. <td class="mlabels-right">
  259. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span> </td>
  260. </tr>
  261. </table>
  262. </div><div class="memdoc">
  263. </div>
  264. </div>
  265. <a class="anchor" id="a16320b2185bda0965e51a73bf0fb9472"></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::ServerInterface::PerformOpsOnCall </td>
  274. <td>(</td>
  275. <td class="paramtype"><a class="el" href="classgrpc_1_1_call_op_set_interface.html">CallOpSetInterface</a> *&#160;</td>
  276. <td class="paramname"><em>ops</em>, </td>
  277. </tr>
  278. <tr>
  279. <td class="paramkey"></td>
  280. <td></td>
  281. <td class="paramtype"><a class="el" href="classgrpc_1_1_call.html">Call</a> *&#160;</td>
  282. <td class="paramname"><em>call</em>&#160;</td>
  283. </tr>
  284. <tr>
  285. <td></td>
  286. <td>)</td>
  287. <td></td><td></td>
  288. </tr>
  289. </table>
  290. </td>
  291. <td class="mlabels-right">
  292. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span> </td>
  293. </tr>
  294. </table>
  295. </div><div class="memdoc">
  296. <p>Implements <a class="el" href="classgrpc_1_1_call_hook.html#acf08b6dd7d1faba4efeeb4937bc81d29">grpc::CallHook</a>.</p>
  297. </div>
  298. </div>
  299. <a class="anchor" id="adaddf784fcb65fca743b04e1803f72ae"></a>
  300. <div class="memitem">
  301. <div class="memproto">
  302. <table class="mlabels">
  303. <tr>
  304. <td class="mlabels-left">
  305. <table class="memname">
  306. <tr>
  307. <td class="memname">virtual void grpc::ServerInterface::RegisterAsyncGenericService </td>
  308. <td>(</td>
  309. <td class="paramtype"><a class="el" href="classgrpc_1_1_async_generic_service.html">AsyncGenericService</a> *&#160;</td>
  310. <td class="paramname"><em>service</em></td><td>)</td>
  311. <td></td>
  312. </tr>
  313. </table>
  314. </td>
  315. <td class="mlabels-right">
  316. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span> </td>
  317. </tr>
  318. </table>
  319. </div><div class="memdoc">
  320. <p>Register a generic service. </p>
  321. <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="Models a gRPC server. ">Server</a> instance. </p>
  322. </div>
  323. </div>
  324. <a class="anchor" id="af51988df89cdcc8ad7b0b1d528717dad"></a>
  325. <div class="memitem">
  326. <div class="memproto">
  327. <table class="mlabels">
  328. <tr>
  329. <td class="mlabels-left">
  330. <table class="memname">
  331. <tr>
  332. <td class="memname">virtual bool grpc::ServerInterface::RegisterService </td>
  333. <td>(</td>
  334. <td class="paramtype">const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> *&#160;</td>
  335. <td class="paramname"><em>host</em>, </td>
  336. </tr>
  337. <tr>
  338. <td class="paramkey"></td>
  339. <td></td>
  340. <td class="paramtype"><a class="el" href="classgrpc_1_1_service.html">Service</a> *&#160;</td>
  341. <td class="paramname"><em>service</em>&#160;</td>
  342. </tr>
  343. <tr>
  344. <td></td>
  345. <td>)</td>
  346. <td></td><td></td>
  347. </tr>
  348. </table>
  349. </td>
  350. <td class="mlabels-right">
  351. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span> </td>
  352. </tr>
  353. </table>
  354. </div><div class="memdoc">
  355. <p>Register a service. </p>
  356. <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="Models a gRPC server. ">Server</a> instance. </p>
  357. </div>
  358. </div>
  359. <a class="anchor" id="a021b10549db0d0ae7a4c8fedbdc003fe"></a>
  360. <div class="memitem">
  361. <div class="memproto">
  362. <div class="memtemplate">
  363. template&lt;class Message &gt; </div>
  364. <table class="mlabels">
  365. <tr>
  366. <td class="mlabels-left">
  367. <table class="memname">
  368. <tr>
  369. <td class="memname">void grpc::ServerInterface::RequestAsyncCall </td>
  370. <td>(</td>
  371. <td class="paramtype"><a class="el" href="classgrpc_1_1_rpc_service_method.html">RpcServiceMethod</a> *&#160;</td>
  372. <td class="paramname"><em>method</em>, </td>
  373. </tr>
  374. <tr>
  375. <td class="paramkey"></td>
  376. <td></td>
  377. <td class="paramtype"><a class="el" href="classgrpc_1_1_server_context.html">ServerContext</a> *&#160;</td>
  378. <td class="paramname"><em>context</em>, </td>
  379. </tr>
  380. <tr>
  381. <td class="paramkey"></td>
  382. <td></td>
  383. <td class="paramtype"><a class="el" href="classgrpc_1_1_server_async_streaming_interface.html">ServerAsyncStreamingInterface</a> *&#160;</td>
  384. <td class="paramname"><em>stream</em>, </td>
  385. </tr>
  386. <tr>
  387. <td class="paramkey"></td>
  388. <td></td>
  389. <td class="paramtype"><a class="el" href="classgrpc_1_1_completion_queue.html">CompletionQueue</a> *&#160;</td>
  390. <td class="paramname"><em>call_cq</em>, </td>
  391. </tr>
  392. <tr>
  393. <td class="paramkey"></td>
  394. <td></td>
  395. <td class="paramtype"><a class="el" href="classgrpc_1_1_server_completion_queue.html">ServerCompletionQueue</a> *&#160;</td>
  396. <td class="paramname"><em>notification_cq</em>, </td>
  397. </tr>
  398. <tr>
  399. <td class="paramkey"></td>
  400. <td></td>
  401. <td class="paramtype">void *&#160;</td>
  402. <td class="paramname"><em>tag</em>, </td>
  403. </tr>
  404. <tr>
  405. <td class="paramkey"></td>
  406. <td></td>
  407. <td class="paramtype">Message *&#160;</td>
  408. <td class="paramname"><em>message</em>&#160;</td>
  409. </tr>
  410. <tr>
  411. <td></td>
  412. <td>)</td>
  413. <td></td><td></td>
  414. </tr>
  415. </table>
  416. </td>
  417. <td class="mlabels-right">
  418. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
  419. </tr>
  420. </table>
  421. </div><div class="memdoc">
  422. </div>
  423. </div>
  424. <a class="anchor" id="a40c1070113c5c6edfeb95dc835a3a996"></a>
  425. <div class="memitem">
  426. <div class="memproto">
  427. <table class="mlabels">
  428. <tr>
  429. <td class="mlabels-left">
  430. <table class="memname">
  431. <tr>
  432. <td class="memname">void grpc::ServerInterface::RequestAsyncCall </td>
  433. <td>(</td>
  434. <td class="paramtype"><a class="el" href="classgrpc_1_1_rpc_service_method.html">RpcServiceMethod</a> *&#160;</td>
  435. <td class="paramname"><em>method</em>, </td>
  436. </tr>
  437. <tr>
  438. <td class="paramkey"></td>
  439. <td></td>
  440. <td class="paramtype"><a class="el" href="classgrpc_1_1_server_context.html">ServerContext</a> *&#160;</td>
  441. <td class="paramname"><em>context</em>, </td>
  442. </tr>
  443. <tr>
  444. <td class="paramkey"></td>
  445. <td></td>
  446. <td class="paramtype"><a class="el" href="classgrpc_1_1_server_async_streaming_interface.html">ServerAsyncStreamingInterface</a> *&#160;</td>
  447. <td class="paramname"><em>stream</em>, </td>
  448. </tr>
  449. <tr>
  450. <td class="paramkey"></td>
  451. <td></td>
  452. <td class="paramtype"><a class="el" href="classgrpc_1_1_completion_queue.html">CompletionQueue</a> *&#160;</td>
  453. <td class="paramname"><em>call_cq</em>, </td>
  454. </tr>
  455. <tr>
  456. <td class="paramkey"></td>
  457. <td></td>
  458. <td class="paramtype"><a class="el" href="classgrpc_1_1_server_completion_queue.html">ServerCompletionQueue</a> *&#160;</td>
  459. <td class="paramname"><em>notification_cq</em>, </td>
  460. </tr>
  461. <tr>
  462. <td class="paramkey"></td>
  463. <td></td>
  464. <td class="paramtype">void *&#160;</td>
  465. <td class="paramname"><em>tag</em>&#160;</td>
  466. </tr>
  467. <tr>
  468. <td></td>
  469. <td>)</td>
  470. <td></td><td></td>
  471. </tr>
  472. </table>
  473. </td>
  474. <td class="mlabels-right">
  475. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
  476. </tr>
  477. </table>
  478. </div><div class="memdoc">
  479. </div>
  480. </div>
  481. <a class="anchor" id="abee9c5991c49712bfe329a4d72ef9590"></a>
  482. <div class="memitem">
  483. <div class="memproto">
  484. <table class="mlabels">
  485. <tr>
  486. <td class="mlabels-left">
  487. <table class="memname">
  488. <tr>
  489. <td class="memname">void grpc::ServerInterface::RequestAsyncGenericCall </td>
  490. <td>(</td>
  491. <td class="paramtype"><a class="el" href="classgrpc_1_1_generic_server_context.html">GenericServerContext</a> *&#160;</td>
  492. <td class="paramname"><em>context</em>, </td>
  493. </tr>
  494. <tr>
  495. <td class="paramkey"></td>
  496. <td></td>
  497. <td class="paramtype"><a class="el" href="classgrpc_1_1_server_async_streaming_interface.html">ServerAsyncStreamingInterface</a> *&#160;</td>
  498. <td class="paramname"><em>stream</em>, </td>
  499. </tr>
  500. <tr>
  501. <td class="paramkey"></td>
  502. <td></td>
  503. <td class="paramtype"><a class="el" href="classgrpc_1_1_completion_queue.html">CompletionQueue</a> *&#160;</td>
  504. <td class="paramname"><em>call_cq</em>, </td>
  505. </tr>
  506. <tr>
  507. <td class="paramkey"></td>
  508. <td></td>
  509. <td class="paramtype"><a class="el" href="classgrpc_1_1_server_completion_queue.html">ServerCompletionQueue</a> *&#160;</td>
  510. <td class="paramname"><em>notification_cq</em>, </td>
  511. </tr>
  512. <tr>
  513. <td class="paramkey"></td>
  514. <td></td>
  515. <td class="paramtype">void *&#160;</td>
  516. <td class="paramname"><em>tag</em>&#160;</td>
  517. </tr>
  518. <tr>
  519. <td></td>
  520. <td>)</td>
  521. <td></td><td></td>
  522. </tr>
  523. </table>
  524. </td>
  525. <td class="mlabels-right">
  526. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
  527. </tr>
  528. </table>
  529. </div><div class="memdoc">
  530. </div>
  531. </div>
  532. <a class="anchor" id="a0026d00c08dca06277a5bc5acf3a9c1f"></a>
  533. <div class="memitem">
  534. <div class="memproto">
  535. <table class="mlabels">
  536. <tr>
  537. <td class="mlabels-left">
  538. <table class="memname">
  539. <tr>
  540. <td class="memname">virtual void grpc::ServerInterface::RunRpc </td>
  541. <td>(</td>
  542. <td class="paramname"></td><td>)</td>
  543. <td></td>
  544. </tr>
  545. </table>
  546. </td>
  547. <td class="mlabels-right">
  548. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span> </td>
  549. </tr>
  550. </table>
  551. </div><div class="memdoc">
  552. <p>Process one or more incoming calls. </p>
  553. </div>
  554. </div>
  555. <a class="anchor" id="a0e95f7753d8569fe645b20104c20cef8"></a>
  556. <div class="memitem">
  557. <div class="memproto">
  558. <table class="mlabels">
  559. <tr>
  560. <td class="mlabels-left">
  561. <table class="memname">
  562. <tr>
  563. <td class="memname">virtual void grpc::ServerInterface::ScheduleCallback </td>
  564. <td>(</td>
  565. <td class="paramname"></td><td>)</td>
  566. <td></td>
  567. </tr>
  568. </table>
  569. </td>
  570. <td class="mlabels-right">
  571. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span> </td>
  572. </tr>
  573. </table>
  574. </div><div class="memdoc">
  575. <p>Schedule <em>RunRpc</em> to run in the threadpool. </p>
  576. </div>
  577. </div>
  578. <a class="anchor" id="a8e9cf80377d3fd1f110089ad16ec79e7"></a>
  579. <div class="memitem">
  580. <div class="memproto">
  581. <table class="mlabels">
  582. <tr>
  583. <td class="mlabels-left">
  584. <table class="memname">
  585. <tr>
  586. <td class="memname">virtual grpc_server* grpc::ServerInterface::server </td>
  587. <td>(</td>
  588. <td class="paramname"></td><td>)</td>
  589. <td></td>
  590. </tr>
  591. </table>
  592. </td>
  593. <td class="mlabels-right">
  594. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span> </td>
  595. </tr>
  596. </table>
  597. </div><div class="memdoc">
  598. </div>
  599. </div>
  600. <a class="anchor" id="a644772d11101318f1424e595dee73ccf"></a>
  601. <div class="memitem">
  602. <div class="memproto">
  603. <div class="memtemplate">
  604. template&lt;class T &gt; </div>
  605. <table class="mlabels">
  606. <tr>
  607. <td class="mlabels-left">
  608. <table class="memname">
  609. <tr>
  610. <td class="memname">void grpc::ServerInterface::Shutdown </td>
  611. <td>(</td>
  612. <td class="paramtype">const T &amp;&#160;</td>
  613. <td class="paramname"><em>deadline</em></td><td>)</td>
  614. <td></td>
  615. </tr>
  616. </table>
  617. </td>
  618. <td class="mlabels-right">
  619. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  620. </tr>
  621. </table>
  622. </div><div class="memdoc">
  623. <p>Shutdown the server, blocking until all rpc processing finishes. </p>
  624. <p>Forcefully terminate pending calls after <em>deadline</em> expires.</p>
  625. <dl class="params"><dt>Parameters</dt><dd>
  626. <table class="params">
  627. <tr><td class="paramname">deadline</td><td>How long to wait until pending rpcs are forcefully terminated. </td></tr>
  628. </table>
  629. </dd>
  630. </dl>
  631. </div>
  632. </div>
  633. <a class="anchor" id="a6a1d337270116c95f387e0abf01f6c6c"></a>
  634. <div class="memitem">
  635. <div class="memproto">
  636. <table class="mlabels">
  637. <tr>
  638. <td class="mlabels-left">
  639. <table class="memname">
  640. <tr>
  641. <td class="memname">void grpc::ServerInterface::Shutdown </td>
  642. <td>(</td>
  643. <td class="paramname"></td><td>)</td>
  644. <td></td>
  645. </tr>
  646. </table>
  647. </td>
  648. <td class="mlabels-right">
  649. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  650. </tr>
  651. </table>
  652. </div><div class="memdoc">
  653. <p>Shutdown the server, waiting for all rpc processing to finish. </p>
  654. </div>
  655. </div>
  656. <a class="anchor" id="a862fd9a2d64e66447d41d0aba40af2f9"></a>
  657. <div class="memitem">
  658. <div class="memproto">
  659. <table class="mlabels">
  660. <tr>
  661. <td class="mlabels-left">
  662. <table class="memname">
  663. <tr>
  664. <td class="memname">virtual void grpc::ServerInterface::ShutdownInternal </td>
  665. <td>(</td>
  666. <td class="paramtype">gpr_timespec&#160;</td>
  667. <td class="paramname"><em>deadline</em></td><td>)</td>
  668. <td></td>
  669. </tr>
  670. </table>
  671. </td>
  672. <td class="mlabels-right">
  673. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span> </td>
  674. </tr>
  675. </table>
  676. </div><div class="memdoc">
  677. </div>
  678. </div>
  679. <a class="anchor" id="aa0bd69382b7e6d35e34190d4faefa039"></a>
  680. <div class="memitem">
  681. <div class="memproto">
  682. <table class="mlabels">
  683. <tr>
  684. <td class="mlabels-left">
  685. <table class="memname">
  686. <tr>
  687. <td class="memname">virtual bool grpc::ServerInterface::Start </td>
  688. <td>(</td>
  689. <td class="paramtype"><a class="el" href="classgrpc_1_1_server_completion_queue.html">ServerCompletionQueue</a> **&#160;</td>
  690. <td class="paramname"><em>cqs</em>, </td>
  691. </tr>
  692. <tr>
  693. <td class="paramkey"></td>
  694. <td></td>
  695. <td class="paramtype">size_t&#160;</td>
  696. <td class="paramname"><em>num_cqs</em>&#160;</td>
  697. </tr>
  698. <tr>
  699. <td></td>
  700. <td>)</td>
  701. <td></td><td></td>
  702. </tr>
  703. </table>
  704. </td>
  705. <td class="mlabels-right">
  706. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span> </td>
  707. </tr>
  708. </table>
  709. </div><div class="memdoc">
  710. <p>Start the server. </p>
  711. <dl class="params"><dt>Parameters</dt><dd>
  712. <table class="params">
  713. <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>
  714. <tr><td class="paramname">num_cqs</td><td>How many completion queues does <em>cqs</em> hold.</td></tr>
  715. </table>
  716. </dd>
  717. </dl>
  718. <dl class="section return"><dt>Returns</dt><dd>true on a successful shutdown. </dd></dl>
  719. </div>
  720. </div>
  721. <a class="anchor" id="ac36477b6a7593a4e4608c7eb712b0d70"></a>
  722. <div class="memitem">
  723. <div class="memproto">
  724. <table class="mlabels">
  725. <tr>
  726. <td class="mlabels-left">
  727. <table class="memname">
  728. <tr>
  729. <td class="memname">virtual void grpc::ServerInterface::Wait </td>
  730. <td>(</td>
  731. <td class="paramname"></td><td>)</td>
  732. <td></td>
  733. </tr>
  734. </table>
  735. </td>
  736. <td class="mlabels-right">
  737. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  738. </tr>
  739. </table>
  740. </div><div class="memdoc">
  741. <p>Block waiting for all work to complete. </p>
  742. <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>
  743. <p>Implemented in <a class="el" href="classgrpc_1_1_server.html#a298f4e18900e7083eb73c64168f1f324">grpc::Server</a>.</p>
  744. </div>
  745. </div>
  746. <h2 class="groupheader">Friends And Related Function Documentation</h2>
  747. <a class="anchor" id="a6474ceb8669761e879329b39c3afb899"></a>
  748. <div class="memitem">
  749. <div class="memproto">
  750. <table class="mlabels">
  751. <tr>
  752. <td class="mlabels-left">
  753. <table class="memname">
  754. <tr>
  755. <td class="memname">friend class <a class="el" href="classgrpc_1_1_service.html">Service</a></td>
  756. </tr>
  757. </table>
  758. </td>
  759. <td class="mlabels-right">
  760. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  761. </tr>
  762. </table>
  763. </div><div class="memdoc">
  764. </div>
  765. </div>
  766. <hr/>The documentation for this class was generated from the following file:<ul>
  767. <li>include/grpc++/impl/codegen/<a class="el" href="server__interface_8h_source.html">server_interface.h</a></li>
  768. </ul>
  769. </div><!-- contents -->
  770. <!-- start footer part -->
  771. <hr class="footer"/><address class="footer"><small>
  772. Generated on Tue Mar 8 2016 15:59:03 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  773. <img class="footer" src="doxygen.png" alt="doxygen"/>
  774. </a> 1.8.6
  775. </small></address>
  776. </body>
  777. </html>