classgrpc_1_1_server_builder.html 55 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937
  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.13"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>GRPC C++: grpc::ServerBuilder Class Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. <script type="text/javascript"> (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); ga('create', 'UA-60127042-1', 'auto'); ga('send', 'pageview'); </script></head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectalign" style="padding-left: 0.5em;">
  24. <div id="projectname">GRPC C++
  25. &#160;<span id="projectnumber">1.13.0-dev</span>
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.8.13 -->
  34. <script type="text/javascript">
  35. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  36. </script>
  37. <script type="text/javascript" src="menudata.js"></script>
  38. <script type="text/javascript" src="menu.js"></script>
  39. <script type="text/javascript">
  40. $(function() {
  41. initMenu('',true,false,'search.php','Search');
  42. $(document).ready(function() { init_search(); });
  43. });
  44. </script>
  45. <div id="main-nav"></div>
  46. <!-- window showing the filter options -->
  47. <div id="MSearchSelectWindow"
  48. onmouseover="return searchBox.OnSearchSelectShow()"
  49. onmouseout="return searchBox.OnSearchSelectHide()"
  50. onkeydown="return searchBox.OnSearchSelectKey(event)">
  51. </div>
  52. <!-- iframe showing the search results (closed by default) -->
  53. <div id="MSearchResultsWindow">
  54. <iframe src="javascript:void(0)" frameborder="0"
  55. name="MSearchResults" id="MSearchResults">
  56. </iframe>
  57. </div>
  58. <div id="nav-path" class="navpath">
  59. <ul>
  60. <li class="navelem"><a class="el" href="namespacegrpc.html">grpc</a></li><li class="navelem"><a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a></li> </ul>
  61. </div>
  62. </div><!-- top -->
  63. <div class="header">
  64. <div class="summary">
  65. <a href="#nested-classes">Data Structures</a> &#124;
  66. <a href="#pub-types">Public Types</a> &#124;
  67. <a href="#pub-methods">Public Member Functions</a> &#124;
  68. <a href="#pub-static-methods">Static Public Member Functions</a> &#124;
  69. <a href="#pro-types">Protected Types</a> &#124;
  70. <a href="#pro-methods">Protected Member Functions</a> &#124;
  71. <a href="#friends">Friends</a> </div>
  72. <div class="headertitle">
  73. <div class="title">grpc::ServerBuilder Class Reference</div> </div>
  74. </div><!--header-->
  75. <div class="contents">
  76. <p>A builder class for the creation and startup of <em><a class="el" href="classgrpc_1_1_server.html" title="Represents a gRPC server. ">grpc::Server</a></em> instances.
  77. <a href="classgrpc_1_1_server_builder.html#details">More...</a></p>
  78. <p><code>#include &lt;<a class="el" href="grpcpp_2server__builder_8h_source.html">server_builder.h</a>&gt;</code></p>
  79. <table class="memberdecls">
  80. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  81. Data Structures</h2></td></tr>
  82. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc_1_1_server_builder_1_1_named_service.html">NamedService</a></td></tr>
  83. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc_1_1_server_builder_1_1_port.html">Port</a></td></tr>
  85. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Experimental, to be deprecated. <a href="structgrpc_1_1_server_builder_1_1_port.html#details">More...</a><br /></td></tr>
  86. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. </table><table class="memberdecls">
  88. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
  89. Public Types</h2></td></tr>
  90. <tr class="memitem:aff66bd93cba7d4240a64550fe1fca88d"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_builder.html#aff66bd93cba7d4240a64550fe1fca88d">SyncServerOption</a> { <a class="el" href="classgrpc_1_1_server_builder.html#aff66bd93cba7d4240a64550fe1fca88da9514f2add3875fc14c843f6498dc1319">NUM_CQS</a>,
  91. <a class="el" href="classgrpc_1_1_server_builder.html#aff66bd93cba7d4240a64550fe1fca88da74d9b7562f58282d93a3a0e5fb02ab02">MIN_POLLERS</a>,
  92. <a class="el" href="classgrpc_1_1_server_builder.html#aff66bd93cba7d4240a64550fe1fca88da3b9b382bb2f70cabe793e3e3fd325910">MAX_POLLERS</a>,
  93. <a class="el" href="classgrpc_1_1_server_builder.html#aff66bd93cba7d4240a64550fe1fca88dad9d34ee45d9bdf2344c6463deea14f4c">CQ_TIMEOUT_MSEC</a>
  94. }<tr class="memdesc:aff66bd93cba7d4240a64550fe1fca88d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Options for synchronous servers. <a href="classgrpc_1_1_server_builder.html#aff66bd93cba7d4240a64550fe1fca88d">More...</a><br /></td></tr>
  95. </td></tr>
  96. <tr class="separator:aff66bd93cba7d4240a64550fe1fca88d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. </table><table class="memberdecls">
  98. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  99. Public Member Functions</h2></td></tr>
  100. <tr class="memitem:a208346e343cd01351492f0cace59b242"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_builder.html#a208346e343cd01351492f0cace59b242">ServerBuilder</a> ()</td></tr>
  101. <tr class="separator:a208346e343cd01351492f0cace59b242"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:a0bf5d1d50d4e5522ba90bc0efcf91b19"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_builder.html#a0bf5d1d50d4e5522ba90bc0efcf91b19">~ServerBuilder</a> ()</td></tr>
  103. <tr class="separator:a0bf5d1d50d4e5522ba90bc0efcf91b19"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:aa3966340091070dd68fa831a03e1e6ef"><td class="memItemLeft" align="right" valign="top">virtual std::unique_ptr&lt; <a class="el" href="classgrpc_1_1_server.html">Server</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_builder.html#aa3966340091070dd68fa831a03e1e6ef">BuildAndStart</a> ()</td></tr>
  105. <tr class="memdesc:aa3966340091070dd68fa831a03e1e6ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a running server which is ready for processing calls. <a href="#aa3966340091070dd68fa831a03e1e6ef">More...</a><br /></td></tr>
  106. <tr class="separator:aa3966340091070dd68fa831a03e1e6ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:a5300484238239412a11e0a9c49435d7e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_builder.html#a5300484238239412a11e0a9c49435d7e">RegisterService</a> (<a class="el" href="classgrpc_1_1_service.html">Service</a> *service)</td></tr>
  108. <tr class="memdesc:a5300484238239412a11e0a9c49435d7e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Register a service. <a href="#a5300484238239412a11e0a9c49435d7e">More...</a><br /></td></tr>
  109. <tr class="separator:a5300484238239412a11e0a9c49435d7e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="memitem:a5bf2d8c40e6b4ca170b9ee927d4db326"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_builder.html#a5bf2d8c40e6b4ca170b9ee927d4db326">AddListeningPort</a> (const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;addr_uri, std::shared_ptr&lt; <a class="el" href="classgrpc_1_1_server_credentials.html">ServerCredentials</a> &gt; creds, int *selected_port=nullptr)</td></tr>
  111. <tr class="memdesc:a5bf2d8c40e6b4ca170b9ee927d4db326"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enlists an endpoint <em>addr</em> (port with an optional IP address) to bind the <em><a class="el" href="classgrpc_1_1_server.html" title="Represents a gRPC server. ">grpc::Server</a></em> object to be created to. <a href="#a5bf2d8c40e6b4ca170b9ee927d4db326">More...</a><br /></td></tr>
  112. <tr class="separator:a5bf2d8c40e6b4ca170b9ee927d4db326"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <tr class="memitem:a960d55977e1aef56fd7b582037a01bbd"><td class="memItemLeft" align="right" valign="top">std::unique_ptr&lt; <a class="el" href="classgrpc_1_1_server_completion_queue.html">ServerCompletionQueue</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_builder.html#a960d55977e1aef56fd7b582037a01bbd">AddCompletionQueue</a> (bool is_frequently_polled=true)</td></tr>
  114. <tr class="memdesc:a960d55977e1aef56fd7b582037a01bbd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a completion queue for handling asynchronous services. <a href="#a960d55977e1aef56fd7b582037a01bbd">More...</a><br /></td></tr>
  115. <tr class="separator:a960d55977e1aef56fd7b582037a01bbd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. <tr class="memitem:a0b06b5828b892feeb6541c8eeae2d542"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_builder.html#a0b06b5828b892feeb6541c8eeae2d542">RegisterService</a> (const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;host, <a class="el" href="classgrpc_1_1_service.html">Service</a> *service)</td></tr>
  117. <tr class="memdesc:a0b06b5828b892feeb6541c8eeae2d542"><td class="mdescLeft">&#160;</td><td class="mdescRight">Register a service. <a href="#a0b06b5828b892feeb6541c8eeae2d542">More...</a><br /></td></tr>
  118. <tr class="separator:a0b06b5828b892feeb6541c8eeae2d542"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. <tr class="memitem:a06468091b05b8bba676a0b94ca8e1281"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_builder.html#a06468091b05b8bba676a0b94ca8e1281">RegisterAsyncGenericService</a> (<a class="el" href="classgrpc_1_1_async_generic_service.html">AsyncGenericService</a> *service)</td></tr>
  120. <tr class="memdesc:a06468091b05b8bba676a0b94ca8e1281"><td class="mdescLeft">&#160;</td><td class="mdescRight">Register a generic service. <a href="#a06468091b05b8bba676a0b94ca8e1281">More...</a><br /></td></tr>
  121. <tr class="separator:a06468091b05b8bba676a0b94ca8e1281"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="memitem:ab5c8a420f2acfc6fcea2f2210e9d426e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_builder.html#ab5c8a420f2acfc6fcea2f2210e9d426e">SetMaxReceiveMessageSize</a> (int max_receive_message_size)</td></tr>
  123. <tr class="memdesc:ab5c8a420f2acfc6fcea2f2210e9d426e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set max receive message size in bytes. <a href="#ab5c8a420f2acfc6fcea2f2210e9d426e">More...</a><br /></td></tr>
  124. <tr class="separator:ab5c8a420f2acfc6fcea2f2210e9d426e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <tr class="memitem:ac6deb0d17c9439febcd04f813fec8a05"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_builder.html#ac6deb0d17c9439febcd04f813fec8a05">SetMaxSendMessageSize</a> (int max_send_message_size)</td></tr>
  126. <tr class="memdesc:ac6deb0d17c9439febcd04f813fec8a05"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set max send message size in bytes. <a href="#ac6deb0d17c9439febcd04f813fec8a05">More...</a><br /></td></tr>
  127. <tr class="separator:ac6deb0d17c9439febcd04f813fec8a05"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:a13f4b030529c9f447e3a172a6d8a7e29"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_builder.html#a13f4b030529c9f447e3a172a6d8a7e29">SetMaxMessageSize</a> (int max_message_size)</td></tr>
  129. <tr class="separator:a13f4b030529c9f447e3a172a6d8a7e29"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. <tr class="memitem:a26e4b20a377c4bbbe37c33aa72165034"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_builder.html#a26e4b20a377c4bbbe37c33aa72165034">SetCompressionAlgorithmSupportStatus</a> (<a class="el" href="compression__types_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a> <a class="el" href="classgrpc_1_1_server_builder.html#a27b5a3733140caef60846fc21977d6ba">algorithm</a>, bool enabled)</td></tr>
  131. <tr class="memdesc:a26e4b20a377c4bbbe37c33aa72165034"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the support status for compression algorithms. <a href="#a26e4b20a377c4bbbe37c33aa72165034">More...</a><br /></td></tr>
  132. <tr class="separator:a26e4b20a377c4bbbe37c33aa72165034"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. <tr class="memitem:ae10c6dc23ec295695710c0b4c14f9353"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_builder.html#ae10c6dc23ec295695710c0b4c14f9353">SetDefaultCompressionLevel</a> (<a class="el" href="compression__types_8h.html#a14a79ed6b5ebd7e1dda7c2684f499cc7">grpc_compression_level</a> <a class="el" href="classgrpc_1_1_server_builder.html#a99bc7fd30172c4e154b6942e1c221a1c">level</a>)</td></tr>
  134. <tr class="memdesc:ae10c6dc23ec295695710c0b4c14f9353"><td class="mdescLeft">&#160;</td><td class="mdescRight">The default compression level to use for all channel calls in the absence of a call-specific level. <a href="#ae10c6dc23ec295695710c0b4c14f9353">More...</a><br /></td></tr>
  135. <tr class="separator:ae10c6dc23ec295695710c0b4c14f9353"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. <tr class="memitem:a6ee516b7445ff4e1274a6d882f529504"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_builder.html#a6ee516b7445ff4e1274a6d882f529504">SetDefaultCompressionAlgorithm</a> (<a class="el" href="compression__types_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a> <a class="el" href="classgrpc_1_1_server_builder.html#a27b5a3733140caef60846fc21977d6ba">algorithm</a>)</td></tr>
  137. <tr class="memdesc:a6ee516b7445ff4e1274a6d882f529504"><td class="mdescLeft">&#160;</td><td class="mdescRight">The default compression algorithm to use for all channel calls in the absence of a call-specific level. <a href="#a6ee516b7445ff4e1274a6d882f529504">More...</a><br /></td></tr>
  138. <tr class="separator:a6ee516b7445ff4e1274a6d882f529504"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. <tr class="memitem:acf8de0a3b6a99a32a6c52328eaaebf23"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_builder.html#acf8de0a3b6a99a32a6c52328eaaebf23">SetResourceQuota</a> (const <a class="el" href="classgrpc_1_1_resource_quota.html">ResourceQuota</a> &amp;resource_quota)</td></tr>
  140. <tr class="memdesc:acf8de0a3b6a99a32a6c52328eaaebf23"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the attached buffer pool for this server. <a href="#acf8de0a3b6a99a32a6c52328eaaebf23">More...</a><br /></td></tr>
  141. <tr class="separator:acf8de0a3b6a99a32a6c52328eaaebf23"><td class="memSeparator" colspan="2">&#160;</td></tr>
  142. <tr class="memitem:af0480c82eb5881f6d998ff85abe0c99a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_builder.html#af0480c82eb5881f6d998ff85abe0c99a">SetOption</a> (std::unique_ptr&lt; <a class="el" href="classgrpc_1_1_server_builder_option.html">ServerBuilderOption</a> &gt; option)</td></tr>
  143. <tr class="separator:af0480c82eb5881f6d998ff85abe0c99a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. <tr class="memitem:acbc2a859672203e7be097de55e296d4b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_builder.html#acbc2a859672203e7be097de55e296d4b">SetSyncServerOption</a> (<a class="el" href="classgrpc_1_1_server_builder.html#aff66bd93cba7d4240a64550fe1fca88d">SyncServerOption</a> option, int value)</td></tr>
  145. <tr class="memdesc:acbc2a859672203e7be097de55e296d4b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Only useful if this is a Synchronous server. <a href="#acbc2a859672203e7be097de55e296d4b">More...</a><br /></td></tr>
  146. <tr class="separator:acbc2a859672203e7be097de55e296d4b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  147. <tr class="memitem:aefdac3407920a99d119c946d255b100c"><td class="memTemplParams" colspan="2">template&lt;class T &gt; </td></tr>
  148. <tr class="memitem:aefdac3407920a99d119c946d255b100c"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a> &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_builder.html#aefdac3407920a99d119c946d255b100c">AddChannelArgument</a> (const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;arg, const T &amp;value)</td></tr>
  149. <tr class="memdesc:aefdac3407920a99d119c946d255b100c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a channel argument (an escape hatch to tuning core library parameters directly) <a href="#aefdac3407920a99d119c946d255b100c">More...</a><br /></td></tr>
  150. <tr class="separator:aefdac3407920a99d119c946d255b100c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  151. <tr class="memitem:a01715acec890fe4ddc91340bae5ead8c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_builder.html#a01715acec890fe4ddc91340bae5ead8c">EnableWorkaround</a> (<a class="el" href="workaround__list_8h.html#ade8be35fce7415c7234ac22d8b9ad9d2">grpc_workaround_list</a> id)</td></tr>
  152. <tr class="memdesc:a01715acec890fe4ddc91340bae5ead8c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable a server workaround. <a href="#a01715acec890fe4ddc91340bae5ead8c">More...</a><br /></td></tr>
  153. <tr class="separator:a01715acec890fe4ddc91340bae5ead8c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  154. </table><table class="memberdecls">
  155. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
  156. Static Public Member Functions</h2></td></tr>
  157. <tr class="memitem:ae37fe433154b148b9ea9ccb17ac1488a"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_builder.html#ae37fe433154b148b9ea9ccb17ac1488a">InternalAddPluginFactory</a> (std::unique_ptr&lt; <a class="el" href="classgrpc_1_1_server_builder_plugin.html">ServerBuilderPlugin</a> &gt;(*CreatePlugin)())</td></tr>
  158. <tr class="memdesc:ae37fe433154b148b9ea9ccb17ac1488a"><td class="mdescLeft">&#160;</td><td class="mdescRight">For internal use only: Register a <a class="el" href="classgrpc_1_1_server_builder_plugin.html" title="This interface is meant for internal usage only. ">ServerBuilderPlugin</a> factory function. <a href="#ae37fe433154b148b9ea9ccb17ac1488a">More...</a><br /></td></tr>
  159. <tr class="separator:ae37fe433154b148b9ea9ccb17ac1488a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  160. </table><table class="memberdecls">
  161. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-types"></a>
  162. Protected Types</h2></td></tr>
  163. <tr class="memitem:a3d9114a66c038daad94f379161209242"><td class="memItemLeft" align="right" valign="top">typedef std::unique_ptr&lt; <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_builder.html#a3d9114a66c038daad94f379161209242">HostString</a></td></tr>
  164. <tr class="memdesc:a3d9114a66c038daad94f379161209242"><td class="mdescLeft">&#160;</td><td class="mdescRight">Experimental, to be deprecated. <a href="#a3d9114a66c038daad94f379161209242">More...</a><br /></td></tr>
  165. <tr class="separator:a3d9114a66c038daad94f379161209242"><td class="memSeparator" colspan="2">&#160;</td></tr>
  166. </table><table class="memberdecls">
  167. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
  168. Protected Member Functions</h2></td></tr>
  169. <tr class="memitem:a5826774e7c803998238a74ef43b5c811"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="structgrpc_1_1_server_builder_1_1_port.html">Port</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_builder.html#a5826774e7c803998238a74ef43b5c811">ports</a> ()</td></tr>
  170. <tr class="memdesc:a5826774e7c803998238a74ef43b5c811"><td class="mdescLeft">&#160;</td><td class="mdescRight">Experimental, to be deprecated. <a href="#a5826774e7c803998238a74ef43b5c811">More...</a><br /></td></tr>
  171. <tr class="separator:a5826774e7c803998238a74ef43b5c811"><td class="memSeparator" colspan="2">&#160;</td></tr>
  172. <tr class="memitem:a4799eec87ef7d336d0f5db95d273e432"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="structgrpc_1_1_server_builder_1_1_named_service.html">NamedService</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_builder.html#a4799eec87ef7d336d0f5db95d273e432">services</a> ()</td></tr>
  173. <tr class="memdesc:a4799eec87ef7d336d0f5db95d273e432"><td class="mdescLeft">&#160;</td><td class="mdescRight">Experimental, to be deprecated. <a href="#a4799eec87ef7d336d0f5db95d273e432">More...</a><br /></td></tr>
  174. <tr class="separator:a4799eec87ef7d336d0f5db95d273e432"><td class="memSeparator" colspan="2">&#160;</td></tr>
  175. <tr class="memitem:a4d10732684bd9ace89303dd746adfb96"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="classgrpc_1_1_server_builder_option.html">ServerBuilderOption</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_builder.html#a4d10732684bd9ace89303dd746adfb96">options</a> ()</td></tr>
  176. <tr class="memdesc:a4d10732684bd9ace89303dd746adfb96"><td class="mdescLeft">&#160;</td><td class="mdescRight">Experimental, to be deprecated. <a href="#a4d10732684bd9ace89303dd746adfb96">More...</a><br /></td></tr>
  177. <tr class="separator:a4d10732684bd9ace89303dd746adfb96"><td class="memSeparator" colspan="2">&#160;</td></tr>
  178. </table><table class="memberdecls">
  179. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
  180. Friends</h2></td></tr>
  181. <tr class="memitem:a6d051c774efa6448928d2ca4062676d0"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_builder.html#a6d051c774efa6448928d2ca4062676d0">::grpc::testing::ServerBuilderPluginTest</a></td></tr>
  182. <tr class="separator:a6d051c774efa6448928d2ca4062676d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  183. </table>
  184. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  185. <div class="textblock"><p>A builder class for the creation and startup of <em><a class="el" href="classgrpc_1_1_server.html" title="Represents a gRPC server. ">grpc::Server</a></em> instances. </p>
  186. </div><h2 class="groupheader">Member Typedef Documentation</h2>
  187. <a id="a3d9114a66c038daad94f379161209242"></a>
  188. <h2 class="memtitle"><span class="permalink"><a href="#a3d9114a66c038daad94f379161209242">&#9670;&nbsp;</a></span>HostString</h2>
  189. <div class="memitem">
  190. <div class="memproto">
  191. <table class="mlabels">
  192. <tr>
  193. <td class="mlabels-left">
  194. <table class="memname">
  195. <tr>
  196. <td class="memname">typedef std::unique_ptr&lt;<a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a>&gt; <a class="el" href="classgrpc_1_1_server_builder.html#a3d9114a66c038daad94f379161209242">grpc::ServerBuilder::HostString</a></td>
  197. </tr>
  198. </table>
  199. </td>
  200. <td class="mlabels-right">
  201. <span class="mlabels"><span class="mlabel">protected</span></span> </td>
  202. </tr>
  203. </table>
  204. </div><div class="memdoc">
  205. <p>Experimental, to be deprecated. </p>
  206. </div>
  207. </div>
  208. <h2 class="groupheader">Member Enumeration Documentation</h2>
  209. <a id="aff66bd93cba7d4240a64550fe1fca88d"></a>
  210. <h2 class="memtitle"><span class="permalink"><a href="#aff66bd93cba7d4240a64550fe1fca88d">&#9670;&nbsp;</a></span>SyncServerOption</h2>
  211. <div class="memitem">
  212. <div class="memproto">
  213. <table class="memname">
  214. <tr>
  215. <td class="memname">enum <a class="el" href="classgrpc_1_1_server_builder.html#aff66bd93cba7d4240a64550fe1fca88d">grpc::ServerBuilder::SyncServerOption</a></td>
  216. </tr>
  217. </table>
  218. </div><div class="memdoc">
  219. <p>Options for synchronous servers. </p>
  220. <table class="fieldtable">
  221. <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="aff66bd93cba7d4240a64550fe1fca88da9514f2add3875fc14c843f6498dc1319"></a>NUM_CQS&#160;</td><td class="fielddoc"><p>Number of completion queues. </p>
  222. </td></tr>
  223. <tr><td class="fieldname"><a id="aff66bd93cba7d4240a64550fe1fca88da74d9b7562f58282d93a3a0e5fb02ab02"></a>MIN_POLLERS&#160;</td><td class="fielddoc"><p>Minimum number of polling threads. </p>
  224. </td></tr>
  225. <tr><td class="fieldname"><a id="aff66bd93cba7d4240a64550fe1fca88da3b9b382bb2f70cabe793e3e3fd325910"></a>MAX_POLLERS&#160;</td><td class="fielddoc"><p>Maximum number of polling threads. </p>
  226. </td></tr>
  227. <tr><td class="fieldname"><a id="aff66bd93cba7d4240a64550fe1fca88dad9d34ee45d9bdf2344c6463deea14f4c"></a>CQ_TIMEOUT_MSEC&#160;</td><td class="fielddoc"><p>Completion queue timeout in milliseconds. </p>
  228. </td></tr>
  229. </table>
  230. </div>
  231. </div>
  232. <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  233. <a id="a208346e343cd01351492f0cace59b242"></a>
  234. <h2 class="memtitle"><span class="permalink"><a href="#a208346e343cd01351492f0cace59b242">&#9670;&nbsp;</a></span>ServerBuilder()</h2>
  235. <div class="memitem">
  236. <div class="memproto">
  237. <table class="memname">
  238. <tr>
  239. <td class="memname">grpc::ServerBuilder::ServerBuilder </td>
  240. <td>(</td>
  241. <td class="paramname"></td><td>)</td>
  242. <td></td>
  243. </tr>
  244. </table>
  245. </div><div class="memdoc">
  246. </div>
  247. </div>
  248. <a id="a0bf5d1d50d4e5522ba90bc0efcf91b19"></a>
  249. <h2 class="memtitle"><span class="permalink"><a href="#a0bf5d1d50d4e5522ba90bc0efcf91b19">&#9670;&nbsp;</a></span>~ServerBuilder()</h2>
  250. <div class="memitem">
  251. <div class="memproto">
  252. <table class="mlabels">
  253. <tr>
  254. <td class="mlabels-left">
  255. <table class="memname">
  256. <tr>
  257. <td class="memname">virtual grpc::ServerBuilder::~ServerBuilder </td>
  258. <td>(</td>
  259. <td class="paramname"></td><td>)</td>
  260. <td></td>
  261. </tr>
  262. </table>
  263. </td>
  264. <td class="mlabels-right">
  265. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  266. </tr>
  267. </table>
  268. </div><div class="memdoc">
  269. </div>
  270. </div>
  271. <h2 class="groupheader">Member Function Documentation</h2>
  272. <a id="aefdac3407920a99d119c946d255b100c"></a>
  273. <h2 class="memtitle"><span class="permalink"><a href="#aefdac3407920a99d119c946d255b100c">&#9670;&nbsp;</a></span>AddChannelArgument()</h2>
  274. <div class="memitem">
  275. <div class="memproto">
  276. <div class="memtemplate">
  277. template&lt;class T &gt; </div>
  278. <table class="mlabels">
  279. <tr>
  280. <td class="mlabels-left">
  281. <table class="memname">
  282. <tr>
  283. <td class="memname"><a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a>&amp; grpc::ServerBuilder::AddChannelArgument </td>
  284. <td>(</td>
  285. <td class="paramtype">const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;&#160;</td>
  286. <td class="paramname"><em>arg</em>, </td>
  287. </tr>
  288. <tr>
  289. <td class="paramkey"></td>
  290. <td></td>
  291. <td class="paramtype">const T &amp;&#160;</td>
  292. <td class="paramname"><em>value</em>&#160;</td>
  293. </tr>
  294. <tr>
  295. <td></td>
  296. <td>)</td>
  297. <td></td><td></td>
  298. </tr>
  299. </table>
  300. </td>
  301. <td class="mlabels-right">
  302. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  303. </tr>
  304. </table>
  305. </div><div class="memdoc">
  306. <p>Add a channel argument (an escape hatch to tuning core library parameters directly) </p>
  307. </div>
  308. </div>
  309. <a id="a960d55977e1aef56fd7b582037a01bbd"></a>
  310. <h2 class="memtitle"><span class="permalink"><a href="#a960d55977e1aef56fd7b582037a01bbd">&#9670;&nbsp;</a></span>AddCompletionQueue()</h2>
  311. <div class="memitem">
  312. <div class="memproto">
  313. <table class="memname">
  314. <tr>
  315. <td class="memname">std::unique_ptr&lt;<a class="el" href="classgrpc_1_1_server_completion_queue.html">ServerCompletionQueue</a>&gt; grpc::ServerBuilder::AddCompletionQueue </td>
  316. <td>(</td>
  317. <td class="paramtype">bool&#160;</td>
  318. <td class="paramname"><em>is_frequently_polled</em> = <code>true</code></td><td>)</td>
  319. <td></td>
  320. </tr>
  321. </table>
  322. </div><div class="memdoc">
  323. <p>Add a completion queue for handling asynchronous services. </p>
  324. <p>Best performance is typically obtained by using one thread per polling completion queue.</p>
  325. <p>Caller is required to shutdown the server prior to shutting down the returned completion queue. Caller is also required to drain the completion queue after shutting it down. A typical usage scenario:</p>
  326. <p>// While building the server: <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> builder; ... cq_ = builder.AddCompletionQueue(); server_ = builder.BuildAndStart();</p>
  327. <p>// While shutting down the server; server_-&gt;Shutdown(); cq_-&gt;Shutdown(); // Always <em>after</em> the associated server's Shutdown()! // Drain the cq_ that was created void* ignored_tag; bool ignored_ok; while (cq_-&gt;Next(&amp;ignored_tag, &amp;ignored_ok)) { }</p>
  328. <dl class="params"><dt>Parameters</dt><dd>
  329. <table class="params">
  330. <tr><td class="paramname">is_frequently_polled</td><td>This is an optional parameter to inform gRPC library about whether this completion queue would be frequently polled (i.e. by calling <em>Next()</em> or <em>AsyncNext()</em>). The default value is 'true' and is the recommended setting. Setting this to 'false' (i.e. not polling the completion queue frequently) will have a significantly negative performance impact and hence should not be used in production use cases. </td></tr>
  331. </table>
  332. </dd>
  333. </dl>
  334. </div>
  335. </div>
  336. <a id="a5bf2d8c40e6b4ca170b9ee927d4db326"></a>
  337. <h2 class="memtitle"><span class="permalink"><a href="#a5bf2d8c40e6b4ca170b9ee927d4db326">&#9670;&nbsp;</a></span>AddListeningPort()</h2>
  338. <div class="memitem">
  339. <div class="memproto">
  340. <table class="memname">
  341. <tr>
  342. <td class="memname"><a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a>&amp; grpc::ServerBuilder::AddListeningPort </td>
  343. <td>(</td>
  344. <td class="paramtype">const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;&#160;</td>
  345. <td class="paramname"><em>addr_uri</em>, </td>
  346. </tr>
  347. <tr>
  348. <td class="paramkey"></td>
  349. <td></td>
  350. <td class="paramtype">std::shared_ptr&lt; <a class="el" href="classgrpc_1_1_server_credentials.html">ServerCredentials</a> &gt;&#160;</td>
  351. <td class="paramname"><em>creds</em>, </td>
  352. </tr>
  353. <tr>
  354. <td class="paramkey"></td>
  355. <td></td>
  356. <td class="paramtype">int *&#160;</td>
  357. <td class="paramname"><em>selected_port</em> = <code>nullptr</code>&#160;</td>
  358. </tr>
  359. <tr>
  360. <td></td>
  361. <td>)</td>
  362. <td></td><td></td>
  363. </tr>
  364. </table>
  365. </div><div class="memdoc">
  366. <p>Enlists an endpoint <em>addr</em> (port with an optional IP address) to bind the <em><a class="el" href="classgrpc_1_1_server.html" title="Represents a gRPC server. ">grpc::Server</a></em> object to be created to. </p>
  367. <p>It can be invoked multiple times.</p>
  368. <dl class="params"><dt>Parameters</dt><dd>
  369. <table class="params">
  370. <tr><td class="paramname">addr_uri</td><td>The address to try to bind to the server in URI form. If the scheme name is omitted, "dns:///" is assumed. To bind to any address, please use IPv6 any, i.e., [::]:&lt;port&gt;, which also accepts IPv4 connections. Valid values include dns:///localhost:1234, / 192.168.1.1:31416, dns:///[::1]:27182, etc.). </td></tr>
  371. <tr><td class="paramname">creds</td><td>The credentials associated with the server. </td></tr>
  372. <tr><td class="paramname">selected_port[out]</td><td>If not <code>nullptr</code>, gets populated with the port number bound to the <em><a class="el" href="classgrpc_1_1_server.html" title="Represents a gRPC server. ">grpc::Server</a></em> for the corresponding endpoint after it is successfully bound, 0 otherwise. </td></tr>
  373. </table>
  374. </dd>
  375. </dl>
  376. </div>
  377. </div>
  378. <a id="aa3966340091070dd68fa831a03e1e6ef"></a>
  379. <h2 class="memtitle"><span class="permalink"><a href="#aa3966340091070dd68fa831a03e1e6ef">&#9670;&nbsp;</a></span>BuildAndStart()</h2>
  380. <div class="memitem">
  381. <div class="memproto">
  382. <table class="mlabels">
  383. <tr>
  384. <td class="mlabels-left">
  385. <table class="memname">
  386. <tr>
  387. <td class="memname">virtual std::unique_ptr&lt;<a class="el" href="classgrpc_1_1_server.html">Server</a>&gt; grpc::ServerBuilder::BuildAndStart </td>
  388. <td>(</td>
  389. <td class="paramname"></td><td>)</td>
  390. <td></td>
  391. </tr>
  392. </table>
  393. </td>
  394. <td class="mlabels-right">
  395. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  396. </tr>
  397. </table>
  398. </div><div class="memdoc">
  399. <p>Return a running server which is ready for processing calls. </p>
  400. <p>Before calling, one typically needs to ensure that:</p><ol type="1">
  401. <li>a service is registered - so that the server knows what to serve (via RegisterService, or RegisterAsyncGenericService)</li>
  402. <li>a listening port has been added - so the server knows where to receive traffic (via AddListeningPort)</li>
  403. <li>[for async api only] completion queues have been added via AddCompletionQueue </li>
  404. </ol>
  405. </div>
  406. </div>
  407. <a id="a01715acec890fe4ddc91340bae5ead8c"></a>
  408. <h2 class="memtitle"><span class="permalink"><a href="#a01715acec890fe4ddc91340bae5ead8c">&#9670;&nbsp;</a></span>EnableWorkaround()</h2>
  409. <div class="memitem">
  410. <div class="memproto">
  411. <table class="memname">
  412. <tr>
  413. <td class="memname"><a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a>&amp; grpc::ServerBuilder::EnableWorkaround </td>
  414. <td>(</td>
  415. <td class="paramtype"><a class="el" href="workaround__list_8h.html#ade8be35fce7415c7234ac22d8b9ad9d2">grpc_workaround_list</a>&#160;</td>
  416. <td class="paramname"><em>id</em></td><td>)</td>
  417. <td></td>
  418. </tr>
  419. </table>
  420. </div><div class="memdoc">
  421. <p>Enable a server workaround. </p>
  422. <p>Do not use unless you know what the workaround does. For explanation and detailed descriptions of workarounds, see <a class="el" href="workarounds_8md.html">doc/workarounds.md</a>. </p>
  423. </div>
  424. </div>
  425. <a id="ae37fe433154b148b9ea9ccb17ac1488a"></a>
  426. <h2 class="memtitle"><span class="permalink"><a href="#ae37fe433154b148b9ea9ccb17ac1488a">&#9670;&nbsp;</a></span>InternalAddPluginFactory()</h2>
  427. <div class="memitem">
  428. <div class="memproto">
  429. <table class="mlabels">
  430. <tr>
  431. <td class="mlabels-left">
  432. <table class="memname">
  433. <tr>
  434. <td class="memname">static void grpc::ServerBuilder::InternalAddPluginFactory </td>
  435. <td>(</td>
  436. <td class="paramtype">std::unique_ptr&lt; <a class="el" href="classgrpc_1_1_server_builder_plugin.html">ServerBuilderPlugin</a> &gt;(*)()&#160;</td>
  437. <td class="paramname"><em>CreatePlugin</em></td><td>)</td>
  438. <td></td>
  439. </tr>
  440. </table>
  441. </td>
  442. <td class="mlabels-right">
  443. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  444. </tr>
  445. </table>
  446. </div><div class="memdoc">
  447. <p>For internal use only: Register a <a class="el" href="classgrpc_1_1_server_builder_plugin.html" title="This interface is meant for internal usage only. ">ServerBuilderPlugin</a> factory function. </p>
  448. </div>
  449. </div>
  450. <a id="a4d10732684bd9ace89303dd746adfb96"></a>
  451. <h2 class="memtitle"><span class="permalink"><a href="#a4d10732684bd9ace89303dd746adfb96">&#9670;&nbsp;</a></span>options()</h2>
  452. <div class="memitem">
  453. <div class="memproto">
  454. <table class="mlabels">
  455. <tr>
  456. <td class="mlabels-left">
  457. <table class="memname">
  458. <tr>
  459. <td class="memname">std::vector&lt;<a class="el" href="classgrpc_1_1_server_builder_option.html">ServerBuilderOption</a>*&gt; grpc::ServerBuilder::options </td>
  460. <td>(</td>
  461. <td class="paramname"></td><td>)</td>
  462. <td></td>
  463. </tr>
  464. </table>
  465. </td>
  466. <td class="mlabels-right">
  467. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
  468. </tr>
  469. </table>
  470. </div><div class="memdoc">
  471. <p>Experimental, to be deprecated. </p>
  472. </div>
  473. </div>
  474. <a id="a5826774e7c803998238a74ef43b5c811"></a>
  475. <h2 class="memtitle"><span class="permalink"><a href="#a5826774e7c803998238a74ef43b5c811">&#9670;&nbsp;</a></span>ports()</h2>
  476. <div class="memitem">
  477. <div class="memproto">
  478. <table class="mlabels">
  479. <tr>
  480. <td class="mlabels-left">
  481. <table class="memname">
  482. <tr>
  483. <td class="memname">std::vector&lt;<a class="el" href="structgrpc_1_1_server_builder_1_1_port.html">Port</a>&gt; grpc::ServerBuilder::ports </td>
  484. <td>(</td>
  485. <td class="paramname"></td><td>)</td>
  486. <td></td>
  487. </tr>
  488. </table>
  489. </td>
  490. <td class="mlabels-right">
  491. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
  492. </tr>
  493. </table>
  494. </div><div class="memdoc">
  495. <p>Experimental, to be deprecated. </p>
  496. </div>
  497. </div>
  498. <a id="a06468091b05b8bba676a0b94ca8e1281"></a>
  499. <h2 class="memtitle"><span class="permalink"><a href="#a06468091b05b8bba676a0b94ca8e1281">&#9670;&nbsp;</a></span>RegisterAsyncGenericService()</h2>
  500. <div class="memitem">
  501. <div class="memproto">
  502. <table class="memname">
  503. <tr>
  504. <td class="memname"><a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a>&amp; grpc::ServerBuilder::RegisterAsyncGenericService </td>
  505. <td>(</td>
  506. <td class="paramtype"><a class="el" href="classgrpc_1_1_async_generic_service.html">AsyncGenericService</a> *&#160;</td>
  507. <td class="paramname"><em>service</em></td><td>)</td>
  508. <td></td>
  509. </tr>
  510. </table>
  511. </div><div class="memdoc">
  512. <p>Register a generic service. </p>
  513. <p>Matches requests with any :authority This is mostly useful for writing generic gRPC Proxies where the exact serialization format is unknown </p>
  514. </div>
  515. </div>
  516. <a id="a5300484238239412a11e0a9c49435d7e"></a>
  517. <h2 class="memtitle"><span class="permalink"><a href="#a5300484238239412a11e0a9c49435d7e">&#9670;&nbsp;</a></span>RegisterService() <span class="overload">[1/2]</span></h2>
  518. <div class="memitem">
  519. <div class="memproto">
  520. <table class="memname">
  521. <tr>
  522. <td class="memname"><a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a>&amp; grpc::ServerBuilder::RegisterService </td>
  523. <td>(</td>
  524. <td class="paramtype"><a class="el" href="classgrpc_1_1_service.html">Service</a> *&#160;</td>
  525. <td class="paramname"><em>service</em></td><td>)</td>
  526. <td></td>
  527. </tr>
  528. </table>
  529. </div><div class="memdoc">
  530. <p>Register a service. </p>
  531. <p>This call does not take ownership of the service. The service must exist for the lifetime of the <em><a class="el" href="classgrpc_1_1_server.html" title="Represents a gRPC server. ">Server</a></em> instance returned by <em><a class="el" href="classgrpc_1_1_server_builder.html#aa3966340091070dd68fa831a03e1e6ef" title="Return a running server which is ready for processing calls. ">BuildAndStart()</a></em>. Matches requests with any :authority </p>
  532. </div>
  533. </div>
  534. <a id="a0b06b5828b892feeb6541c8eeae2d542"></a>
  535. <h2 class="memtitle"><span class="permalink"><a href="#a0b06b5828b892feeb6541c8eeae2d542">&#9670;&nbsp;</a></span>RegisterService() <span class="overload">[2/2]</span></h2>
  536. <div class="memitem">
  537. <div class="memproto">
  538. <table class="memname">
  539. <tr>
  540. <td class="memname"><a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a>&amp; grpc::ServerBuilder::RegisterService </td>
  541. <td>(</td>
  542. <td class="paramtype">const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;&#160;</td>
  543. <td class="paramname"><em>host</em>, </td>
  544. </tr>
  545. <tr>
  546. <td class="paramkey"></td>
  547. <td></td>
  548. <td class="paramtype"><a class="el" href="classgrpc_1_1_service.html">Service</a> *&#160;</td>
  549. <td class="paramname"><em>service</em>&#160;</td>
  550. </tr>
  551. <tr>
  552. <td></td>
  553. <td>)</td>
  554. <td></td><td></td>
  555. </tr>
  556. </table>
  557. </div><div class="memdoc">
  558. <p>Register a service. </p>
  559. <p>This call does not take ownership of the service. The service must exist for the lifetime of the <em><a class="el" href="classgrpc_1_1_server.html" title="Represents a gRPC server. ">Server</a></em> instance returned by <em><a class="el" href="classgrpc_1_1_server_builder.html#aa3966340091070dd68fa831a03e1e6ef" title="Return a running server which is ready for processing calls. ">BuildAndStart()</a></em>. Only matches requests with :authority <em>host</em> </p>
  560. </div>
  561. </div>
  562. <a id="a4799eec87ef7d336d0f5db95d273e432"></a>
  563. <h2 class="memtitle"><span class="permalink"><a href="#a4799eec87ef7d336d0f5db95d273e432">&#9670;&nbsp;</a></span>services()</h2>
  564. <div class="memitem">
  565. <div class="memproto">
  566. <table class="mlabels">
  567. <tr>
  568. <td class="mlabels-left">
  569. <table class="memname">
  570. <tr>
  571. <td class="memname">std::vector&lt;<a class="el" href="structgrpc_1_1_server_builder_1_1_named_service.html">NamedService</a>*&gt; grpc::ServerBuilder::services </td>
  572. <td>(</td>
  573. <td class="paramname"></td><td>)</td>
  574. <td></td>
  575. </tr>
  576. </table>
  577. </td>
  578. <td class="mlabels-right">
  579. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
  580. </tr>
  581. </table>
  582. </div><div class="memdoc">
  583. <p>Experimental, to be deprecated. </p>
  584. </div>
  585. </div>
  586. <a id="a26e4b20a377c4bbbe37c33aa72165034"></a>
  587. <h2 class="memtitle"><span class="permalink"><a href="#a26e4b20a377c4bbbe37c33aa72165034">&#9670;&nbsp;</a></span>SetCompressionAlgorithmSupportStatus()</h2>
  588. <div class="memitem">
  589. <div class="memproto">
  590. <table class="memname">
  591. <tr>
  592. <td class="memname"><a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a>&amp; grpc::ServerBuilder::SetCompressionAlgorithmSupportStatus </td>
  593. <td>(</td>
  594. <td class="paramtype"><a class="el" href="compression__types_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a>&#160;</td>
  595. <td class="paramname"><em>algorithm</em>, </td>
  596. </tr>
  597. <tr>
  598. <td class="paramkey"></td>
  599. <td></td>
  600. <td class="paramtype">bool&#160;</td>
  601. <td class="paramname"><em>enabled</em>&#160;</td>
  602. </tr>
  603. <tr>
  604. <td></td>
  605. <td>)</td>
  606. <td></td><td></td>
  607. </tr>
  608. </table>
  609. </div><div class="memdoc">
  610. <p>Set the support status for compression algorithms. </p>
  611. <p>All algorithms are enabled by default.</p>
  612. <p>Incoming calls compressed with an unsupported algorithm will fail with <em>GRPC_STATUS_UNIMPLEMENTED</em>. </p>
  613. </div>
  614. </div>
  615. <a id="a6ee516b7445ff4e1274a6d882f529504"></a>
  616. <h2 class="memtitle"><span class="permalink"><a href="#a6ee516b7445ff4e1274a6d882f529504">&#9670;&nbsp;</a></span>SetDefaultCompressionAlgorithm()</h2>
  617. <div class="memitem">
  618. <div class="memproto">
  619. <table class="memname">
  620. <tr>
  621. <td class="memname"><a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a>&amp; grpc::ServerBuilder::SetDefaultCompressionAlgorithm </td>
  622. <td>(</td>
  623. <td class="paramtype"><a class="el" href="compression__types_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a>&#160;</td>
  624. <td class="paramname"><em>algorithm</em></td><td>)</td>
  625. <td></td>
  626. </tr>
  627. </table>
  628. </div><div class="memdoc">
  629. <p>The default compression algorithm to use for all channel calls in the absence of a call-specific level. </p>
  630. <p>Note that it overrides any compression level set by <em>SetDefaultCompressionLevel</em>. </p>
  631. </div>
  632. </div>
  633. <a id="ae10c6dc23ec295695710c0b4c14f9353"></a>
  634. <h2 class="memtitle"><span class="permalink"><a href="#ae10c6dc23ec295695710c0b4c14f9353">&#9670;&nbsp;</a></span>SetDefaultCompressionLevel()</h2>
  635. <div class="memitem">
  636. <div class="memproto">
  637. <table class="memname">
  638. <tr>
  639. <td class="memname"><a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a>&amp; grpc::ServerBuilder::SetDefaultCompressionLevel </td>
  640. <td>(</td>
  641. <td class="paramtype"><a class="el" href="compression__types_8h.html#a14a79ed6b5ebd7e1dda7c2684f499cc7">grpc_compression_level</a>&#160;</td>
  642. <td class="paramname"><em>level</em></td><td>)</td>
  643. <td></td>
  644. </tr>
  645. </table>
  646. </div><div class="memdoc">
  647. <p>The default compression level to use for all channel calls in the absence of a call-specific level. </p>
  648. </div>
  649. </div>
  650. <a id="a13f4b030529c9f447e3a172a6d8a7e29"></a>
  651. <h2 class="memtitle"><span class="permalink"><a href="#a13f4b030529c9f447e3a172a6d8a7e29">&#9670;&nbsp;</a></span>SetMaxMessageSize()</h2>
  652. <div class="memitem">
  653. <div class="memproto">
  654. <table class="mlabels">
  655. <tr>
  656. <td class="mlabels-left">
  657. <table class="memname">
  658. <tr>
  659. <td class="memname"><a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a>&amp; grpc::ServerBuilder::SetMaxMessageSize </td>
  660. <td>(</td>
  661. <td class="paramtype">int&#160;</td>
  662. <td class="paramname"><em>max_message_size</em></td><td>)</td>
  663. <td></td>
  664. </tr>
  665. </table>
  666. </td>
  667. <td class="mlabels-right">
  668. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  669. </tr>
  670. </table>
  671. </div><div class="memdoc">
  672. <dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000002">Deprecated:</a></b></dt><dd>For backward compatibility. </dd></dl>
  673. </div>
  674. </div>
  675. <a id="ab5c8a420f2acfc6fcea2f2210e9d426e"></a>
  676. <h2 class="memtitle"><span class="permalink"><a href="#ab5c8a420f2acfc6fcea2f2210e9d426e">&#9670;&nbsp;</a></span>SetMaxReceiveMessageSize()</h2>
  677. <div class="memitem">
  678. <div class="memproto">
  679. <table class="mlabels">
  680. <tr>
  681. <td class="mlabels-left">
  682. <table class="memname">
  683. <tr>
  684. <td class="memname"><a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a>&amp; grpc::ServerBuilder::SetMaxReceiveMessageSize </td>
  685. <td>(</td>
  686. <td class="paramtype">int&#160;</td>
  687. <td class="paramname"><em>max_receive_message_size</em></td><td>)</td>
  688. <td></td>
  689. </tr>
  690. </table>
  691. </td>
  692. <td class="mlabels-right">
  693. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  694. </tr>
  695. </table>
  696. </div><div class="memdoc">
  697. <p>Set max receive message size in bytes. </p>
  698. </div>
  699. </div>
  700. <a id="ac6deb0d17c9439febcd04f813fec8a05"></a>
  701. <h2 class="memtitle"><span class="permalink"><a href="#ac6deb0d17c9439febcd04f813fec8a05">&#9670;&nbsp;</a></span>SetMaxSendMessageSize()</h2>
  702. <div class="memitem">
  703. <div class="memproto">
  704. <table class="mlabels">
  705. <tr>
  706. <td class="mlabels-left">
  707. <table class="memname">
  708. <tr>
  709. <td class="memname"><a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a>&amp; grpc::ServerBuilder::SetMaxSendMessageSize </td>
  710. <td>(</td>
  711. <td class="paramtype">int&#160;</td>
  712. <td class="paramname"><em>max_send_message_size</em></td><td>)</td>
  713. <td></td>
  714. </tr>
  715. </table>
  716. </td>
  717. <td class="mlabels-right">
  718. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  719. </tr>
  720. </table>
  721. </div><div class="memdoc">
  722. <p>Set max send message size in bytes. </p>
  723. </div>
  724. </div>
  725. <a id="af0480c82eb5881f6d998ff85abe0c99a"></a>
  726. <h2 class="memtitle"><span class="permalink"><a href="#af0480c82eb5881f6d998ff85abe0c99a">&#9670;&nbsp;</a></span>SetOption()</h2>
  727. <div class="memitem">
  728. <div class="memproto">
  729. <table class="memname">
  730. <tr>
  731. <td class="memname"><a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a>&amp; grpc::ServerBuilder::SetOption </td>
  732. <td>(</td>
  733. <td class="paramtype">std::unique_ptr&lt; <a class="el" href="classgrpc_1_1_server_builder_option.html">ServerBuilderOption</a> &gt;&#160;</td>
  734. <td class="paramname"><em>option</em></td><td>)</td>
  735. <td></td>
  736. </tr>
  737. </table>
  738. </div><div class="memdoc">
  739. </div>
  740. </div>
  741. <a id="acf8de0a3b6a99a32a6c52328eaaebf23"></a>
  742. <h2 class="memtitle"><span class="permalink"><a href="#acf8de0a3b6a99a32a6c52328eaaebf23">&#9670;&nbsp;</a></span>SetResourceQuota()</h2>
  743. <div class="memitem">
  744. <div class="memproto">
  745. <table class="memname">
  746. <tr>
  747. <td class="memname"><a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a>&amp; grpc::ServerBuilder::SetResourceQuota </td>
  748. <td>(</td>
  749. <td class="paramtype">const <a class="el" href="classgrpc_1_1_resource_quota.html">ResourceQuota</a> &amp;&#160;</td>
  750. <td class="paramname"><em>resource_quota</em></td><td>)</td>
  751. <td></td>
  752. </tr>
  753. </table>
  754. </div><div class="memdoc">
  755. <p>Set the attached buffer pool for this server. </p>
  756. </div>
  757. </div>
  758. <a id="acbc2a859672203e7be097de55e296d4b"></a>
  759. <h2 class="memtitle"><span class="permalink"><a href="#acbc2a859672203e7be097de55e296d4b">&#9670;&nbsp;</a></span>SetSyncServerOption()</h2>
  760. <div class="memitem">
  761. <div class="memproto">
  762. <table class="memname">
  763. <tr>
  764. <td class="memname"><a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a>&amp; grpc::ServerBuilder::SetSyncServerOption </td>
  765. <td>(</td>
  766. <td class="paramtype"><a class="el" href="classgrpc_1_1_server_builder.html#aff66bd93cba7d4240a64550fe1fca88d">SyncServerOption</a>&#160;</td>
  767. <td class="paramname"><em>option</em>, </td>
  768. </tr>
  769. <tr>
  770. <td class="paramkey"></td>
  771. <td></td>
  772. <td class="paramtype">int&#160;</td>
  773. <td class="paramname"><em>value</em>&#160;</td>
  774. </tr>
  775. <tr>
  776. <td></td>
  777. <td>)</td>
  778. <td></td><td></td>
  779. </tr>
  780. </table>
  781. </div><div class="memdoc">
  782. <p>Only useful if this is a Synchronous server. </p>
  783. </div>
  784. </div>
  785. <h2 class="groupheader">Friends And Related Function Documentation</h2>
  786. <a id="a6d051c774efa6448928d2ca4062676d0"></a>
  787. <h2 class="memtitle"><span class="permalink"><a href="#a6d051c774efa6448928d2ca4062676d0">&#9670;&nbsp;</a></span>::grpc::testing::ServerBuilderPluginTest</h2>
  788. <div class="memitem">
  789. <div class="memproto">
  790. <table class="mlabels">
  791. <tr>
  792. <td class="mlabels-left">
  793. <table class="memname">
  794. <tr>
  795. <td class="memname">friend class ::grpc::testing::ServerBuilderPluginTest</td>
  796. </tr>
  797. </table>
  798. </td>
  799. <td class="mlabels-right">
  800. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  801. </tr>
  802. </table>
  803. </div><div class="memdoc">
  804. </div>
  805. </div>
  806. <h2 class="groupheader">Field Documentation</h2>
  807. <a id="a27b5a3733140caef60846fc21977d6ba"></a>
  808. <h2 class="memtitle"><span class="permalink"><a href="#a27b5a3733140caef60846fc21977d6ba">&#9670;&nbsp;</a></span>algorithm</h2>
  809. <div class="memitem">
  810. <div class="memproto">
  811. <table class="memname">
  812. <tr>
  813. <td class="memname"><a class="el" href="compression__types_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a> grpc::ServerBuilder::algorithm</td>
  814. </tr>
  815. </table>
  816. </div><div class="memdoc">
  817. </div>
  818. </div>
  819. <a id="ab2b0b337e27ae80796675a3dd224ec3a"></a>
  820. <h2 class="memtitle"><span class="permalink"><a href="#ab2b0b337e27ae80796675a3dd224ec3a">&#9670;&nbsp;</a></span>is_set</h2>
  821. <div class="memitem">
  822. <div class="memproto">
  823. <table class="memname">
  824. <tr>
  825. <td class="memname">bool grpc::ServerBuilder::is_set</td>
  826. </tr>
  827. </table>
  828. </div><div class="memdoc">
  829. </div>
  830. </div>
  831. <a id="a99bc7fd30172c4e154b6942e1c221a1c"></a>
  832. <h2 class="memtitle"><span class="permalink"><a href="#a99bc7fd30172c4e154b6942e1c221a1c">&#9670;&nbsp;</a></span>level</h2>
  833. <div class="memitem">
  834. <div class="memproto">
  835. <table class="memname">
  836. <tr>
  837. <td class="memname"><a class="el" href="compression__types_8h.html#a14a79ed6b5ebd7e1dda7c2684f499cc7">grpc_compression_level</a> grpc::ServerBuilder::level</td>
  838. </tr>
  839. </table>
  840. </div><div class="memdoc">
  841. </div>
  842. </div>
  843. <hr/>The documentation for this class was generated from the following file:<ul>
  844. <li>include/grpcpp/<a class="el" href="grpcpp_2server__builder_8h_source.html">server_builder.h</a></li>
  845. </ul>
  846. </div><!-- contents -->
  847. <!-- start footer part -->
  848. <hr class="footer"/><address class="footer"><small>
  849. Generated on Tue May 15 2018 17:01:01 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  850. <img class="footer" src="doxygen.png" alt="doxygen"/>
  851. </a> 1.8.13
  852. </small></address>
  853. </body>
  854. </html>