123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
- <meta http-equiv="X-UA-Compatible" content="IE=9"/>
- <meta name="generator" content="Doxygen 1.8.13"/>
- <meta name="viewport" content="width=device-width, initial-scale=1"/>
- <title>GRPC C++: grpc::ServerBuilder Class Reference</title>
- <link href="tabs.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="jquery.js"></script>
- <script type="text/javascript" src="dynsections.js"></script>
- <link href="search/search.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="search/searchdata.js"></script>
- <script type="text/javascript" src="search/search.js"></script>
- <link href="doxygen.css" rel="stylesheet" type="text/css" />
- <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>
- <body>
- <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
- <div id="titlearea">
- <table cellspacing="0" cellpadding="0">
- <tbody>
- <tr style="height: 56px;">
- <td id="projectalign" style="padding-left: 0.5em;">
- <div id="projectname">GRPC C++
-  <span id="projectnumber">1.13.0-dev</span>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.8.13 -->
- <script type="text/javascript">
- var searchBox = new SearchBox("searchBox", "search",false,'Search');
- </script>
- <script type="text/javascript" src="menudata.js"></script>
- <script type="text/javascript" src="menu.js"></script>
- <script type="text/javascript">
- $(function() {
- initMenu('',true,false,'search.php','Search');
- $(document).ready(function() { init_search(); });
- });
- </script>
- <div id="main-nav"></div>
- <!-- window showing the filter options -->
- <div id="MSearchSelectWindow"
- onmouseover="return searchBox.OnSearchSelectShow()"
- onmouseout="return searchBox.OnSearchSelectHide()"
- onkeydown="return searchBox.OnSearchSelectKey(event)">
- </div>
- <!-- iframe showing the search results (closed by default) -->
- <div id="MSearchResultsWindow">
- <iframe src="javascript:void(0)" frameborder="0"
- name="MSearchResults" id="MSearchResults">
- </iframe>
- </div>
- <div id="nav-path" class="navpath">
- <ul>
- <li class="navelem"><a class="el" href="namespacegrpc.html">grpc</a></li><li class="navelem"><a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a></li> </ul>
- </div>
- </div><!-- top -->
- <div class="header">
- <div class="summary">
- <a href="#nested-classes">Data Structures</a> |
- <a href="#pub-types">Public Types</a> |
- <a href="#pub-methods">Public Member Functions</a> |
- <a href="#pub-static-methods">Static Public Member Functions</a> |
- <a href="#pro-types">Protected Types</a> |
- <a href="#pro-methods">Protected Member Functions</a> |
- <a href="#friends">Friends</a> </div>
- <div class="headertitle">
- <div class="title">grpc::ServerBuilder Class Reference</div> </div>
- </div><!--header-->
- <div class="contents">
- <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.
- <a href="classgrpc_1_1_server_builder.html#details">More...</a></p>
- <p><code>#include <<a class="el" href="grpcpp_2server__builder_8h_source.html">server_builder.h</a>></code></p>
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
- Data Structures</h2></td></tr>
- <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc_1_1_server_builder_1_1_named_service.html">NamedService</a></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc_1_1_server_builder_1_1_port.html">Port</a></td></tr>
- <tr class="memdesc:"><td class="mdescLeft"> </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>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
- Public Types</h2></td></tr>
- <tr class="memitem:aff66bd93cba7d4240a64550fe1fca88d"><td class="memItemLeft" align="right" valign="top">enum  </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>,
- <a class="el" href="classgrpc_1_1_server_builder.html#aff66bd93cba7d4240a64550fe1fca88da74d9b7562f58282d93a3a0e5fb02ab02">MIN_POLLERS</a>,
- <a class="el" href="classgrpc_1_1_server_builder.html#aff66bd93cba7d4240a64550fe1fca88da3b9b382bb2f70cabe793e3e3fd325910">MAX_POLLERS</a>,
- <a class="el" href="classgrpc_1_1_server_builder.html#aff66bd93cba7d4240a64550fe1fca88dad9d34ee45d9bdf2344c6463deea14f4c">CQ_TIMEOUT_MSEC</a>
- }<tr class="memdesc:aff66bd93cba7d4240a64550fe1fca88d"><td class="mdescLeft"> </td><td class="mdescRight">Options for synchronous servers. <a href="classgrpc_1_1_server_builder.html#aff66bd93cba7d4240a64550fe1fca88d">More...</a><br /></td></tr>
- </td></tr>
- <tr class="separator:aff66bd93cba7d4240a64550fe1fca88d"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
- Public Member Functions</h2></td></tr>
- <tr class="memitem:a208346e343cd01351492f0cace59b242"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_builder.html#a208346e343cd01351492f0cace59b242">ServerBuilder</a> ()</td></tr>
- <tr class="separator:a208346e343cd01351492f0cace59b242"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a0bf5d1d50d4e5522ba90bc0efcf91b19"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_builder.html#a0bf5d1d50d4e5522ba90bc0efcf91b19">~ServerBuilder</a> ()</td></tr>
- <tr class="separator:a0bf5d1d50d4e5522ba90bc0efcf91b19"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aa3966340091070dd68fa831a03e1e6ef"><td class="memItemLeft" align="right" valign="top">virtual std::unique_ptr< <a class="el" href="classgrpc_1_1_server.html">Server</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_builder.html#aa3966340091070dd68fa831a03e1e6ef">BuildAndStart</a> ()</td></tr>
- <tr class="memdesc:aa3966340091070dd68fa831a03e1e6ef"><td class="mdescLeft"> </td><td class="mdescRight">Return a running server which is ready for processing calls. <a href="#aa3966340091070dd68fa831a03e1e6ef">More...</a><br /></td></tr>
- <tr class="separator:aa3966340091070dd68fa831a03e1e6ef"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5300484238239412a11e0a9c49435d7e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a> & </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>
- <tr class="memdesc:a5300484238239412a11e0a9c49435d7e"><td class="mdescLeft"> </td><td class="mdescRight">Register a service. <a href="#a5300484238239412a11e0a9c49435d7e">More...</a><br /></td></tr>
- <tr class="separator:a5300484238239412a11e0a9c49435d7e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5bf2d8c40e6b4ca170b9ee927d4db326"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a> & </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> &addr_uri, std::shared_ptr< <a class="el" href="classgrpc_1_1_server_credentials.html">ServerCredentials</a> > creds, int *selected_port=nullptr)</td></tr>
- <tr class="memdesc:a5bf2d8c40e6b4ca170b9ee927d4db326"><td class="mdescLeft"> </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>
- <tr class="separator:a5bf2d8c40e6b4ca170b9ee927d4db326"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a960d55977e1aef56fd7b582037a01bbd"><td class="memItemLeft" align="right" valign="top">std::unique_ptr< <a class="el" href="classgrpc_1_1_server_completion_queue.html">ServerCompletionQueue</a> > </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>
- <tr class="memdesc:a960d55977e1aef56fd7b582037a01bbd"><td class="mdescLeft"> </td><td class="mdescRight">Add a completion queue for handling asynchronous services. <a href="#a960d55977e1aef56fd7b582037a01bbd">More...</a><br /></td></tr>
- <tr class="separator:a960d55977e1aef56fd7b582037a01bbd"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a0b06b5828b892feeb6541c8eeae2d542"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a> & </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> &host, <a class="el" href="classgrpc_1_1_service.html">Service</a> *service)</td></tr>
- <tr class="memdesc:a0b06b5828b892feeb6541c8eeae2d542"><td class="mdescLeft"> </td><td class="mdescRight">Register a service. <a href="#a0b06b5828b892feeb6541c8eeae2d542">More...</a><br /></td></tr>
- <tr class="separator:a0b06b5828b892feeb6541c8eeae2d542"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a06468091b05b8bba676a0b94ca8e1281"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a> & </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>
- <tr class="memdesc:a06468091b05b8bba676a0b94ca8e1281"><td class="mdescLeft"> </td><td class="mdescRight">Register a generic service. <a href="#a06468091b05b8bba676a0b94ca8e1281">More...</a><br /></td></tr>
- <tr class="separator:a06468091b05b8bba676a0b94ca8e1281"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab5c8a420f2acfc6fcea2f2210e9d426e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a> & </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>
- <tr class="memdesc:ab5c8a420f2acfc6fcea2f2210e9d426e"><td class="mdescLeft"> </td><td class="mdescRight">Set max receive message size in bytes. <a href="#ab5c8a420f2acfc6fcea2f2210e9d426e">More...</a><br /></td></tr>
- <tr class="separator:ab5c8a420f2acfc6fcea2f2210e9d426e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac6deb0d17c9439febcd04f813fec8a05"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a> & </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>
- <tr class="memdesc:ac6deb0d17c9439febcd04f813fec8a05"><td class="mdescLeft"> </td><td class="mdescRight">Set max send message size in bytes. <a href="#ac6deb0d17c9439febcd04f813fec8a05">More...</a><br /></td></tr>
- <tr class="separator:ac6deb0d17c9439febcd04f813fec8a05"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a13f4b030529c9f447e3a172a6d8a7e29"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a> & </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>
- <tr class="separator:a13f4b030529c9f447e3a172a6d8a7e29"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a26e4b20a377c4bbbe37c33aa72165034"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a> & </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>
- <tr class="memdesc:a26e4b20a377c4bbbe37c33aa72165034"><td class="mdescLeft"> </td><td class="mdescRight">Set the support status for compression algorithms. <a href="#a26e4b20a377c4bbbe37c33aa72165034">More...</a><br /></td></tr>
- <tr class="separator:a26e4b20a377c4bbbe37c33aa72165034"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ae10c6dc23ec295695710c0b4c14f9353"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a> & </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>
- <tr class="memdesc:ae10c6dc23ec295695710c0b4c14f9353"><td class="mdescLeft"> </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>
- <tr class="separator:ae10c6dc23ec295695710c0b4c14f9353"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a6ee516b7445ff4e1274a6d882f529504"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a> & </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>
- <tr class="memdesc:a6ee516b7445ff4e1274a6d882f529504"><td class="mdescLeft"> </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>
- <tr class="separator:a6ee516b7445ff4e1274a6d882f529504"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:acf8de0a3b6a99a32a6c52328eaaebf23"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a> & </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> &resource_quota)</td></tr>
- <tr class="memdesc:acf8de0a3b6a99a32a6c52328eaaebf23"><td class="mdescLeft"> </td><td class="mdescRight">Set the attached buffer pool for this server. <a href="#acf8de0a3b6a99a32a6c52328eaaebf23">More...</a><br /></td></tr>
- <tr class="separator:acf8de0a3b6a99a32a6c52328eaaebf23"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:af0480c82eb5881f6d998ff85abe0c99a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_builder.html#af0480c82eb5881f6d998ff85abe0c99a">SetOption</a> (std::unique_ptr< <a class="el" href="classgrpc_1_1_server_builder_option.html">ServerBuilderOption</a> > option)</td></tr>
- <tr class="separator:af0480c82eb5881f6d998ff85abe0c99a"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:acbc2a859672203e7be097de55e296d4b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a> & </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>
- <tr class="memdesc:acbc2a859672203e7be097de55e296d4b"><td class="mdescLeft"> </td><td class="mdescRight">Only useful if this is a Synchronous server. <a href="#acbc2a859672203e7be097de55e296d4b">More...</a><br /></td></tr>
- <tr class="separator:acbc2a859672203e7be097de55e296d4b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aefdac3407920a99d119c946d255b100c"><td class="memTemplParams" colspan="2">template<class T > </td></tr>
- <tr class="memitem:aefdac3407920a99d119c946d255b100c"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a> & </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> &arg, const T &value)</td></tr>
- <tr class="memdesc:aefdac3407920a99d119c946d255b100c"><td class="mdescLeft"> </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>
- <tr class="separator:aefdac3407920a99d119c946d255b100c"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a01715acec890fe4ddc91340bae5ead8c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a> & </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>
- <tr class="memdesc:a01715acec890fe4ddc91340bae5ead8c"><td class="mdescLeft"> </td><td class="mdescRight">Enable a server workaround. <a href="#a01715acec890fe4ddc91340bae5ead8c">More...</a><br /></td></tr>
- <tr class="separator:a01715acec890fe4ddc91340bae5ead8c"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
- Static Public Member Functions</h2></td></tr>
- <tr class="memitem:ae37fe433154b148b9ea9ccb17ac1488a"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_builder.html#ae37fe433154b148b9ea9ccb17ac1488a">InternalAddPluginFactory</a> (std::unique_ptr< <a class="el" href="classgrpc_1_1_server_builder_plugin.html">ServerBuilderPlugin</a> >(*CreatePlugin)())</td></tr>
- <tr class="memdesc:ae37fe433154b148b9ea9ccb17ac1488a"><td class="mdescLeft"> </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>
- <tr class="separator:ae37fe433154b148b9ea9ccb17ac1488a"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-types"></a>
- Protected Types</h2></td></tr>
- <tr class="memitem:a3d9114a66c038daad94f379161209242"><td class="memItemLeft" align="right" valign="top">typedef std::unique_ptr< <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_builder.html#a3d9114a66c038daad94f379161209242">HostString</a></td></tr>
- <tr class="memdesc:a3d9114a66c038daad94f379161209242"><td class="mdescLeft"> </td><td class="mdescRight">Experimental, to be deprecated. <a href="#a3d9114a66c038daad94f379161209242">More...</a><br /></td></tr>
- <tr class="separator:a3d9114a66c038daad94f379161209242"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
- Protected Member Functions</h2></td></tr>
- <tr class="memitem:a5826774e7c803998238a74ef43b5c811"><td class="memItemLeft" align="right" valign="top">std::vector< <a class="el" href="structgrpc_1_1_server_builder_1_1_port.html">Port</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_builder.html#a5826774e7c803998238a74ef43b5c811">ports</a> ()</td></tr>
- <tr class="memdesc:a5826774e7c803998238a74ef43b5c811"><td class="mdescLeft"> </td><td class="mdescRight">Experimental, to be deprecated. <a href="#a5826774e7c803998238a74ef43b5c811">More...</a><br /></td></tr>
- <tr class="separator:a5826774e7c803998238a74ef43b5c811"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a4799eec87ef7d336d0f5db95d273e432"><td class="memItemLeft" align="right" valign="top">std::vector< <a class="el" href="structgrpc_1_1_server_builder_1_1_named_service.html">NamedService</a> * > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_builder.html#a4799eec87ef7d336d0f5db95d273e432">services</a> ()</td></tr>
- <tr class="memdesc:a4799eec87ef7d336d0f5db95d273e432"><td class="mdescLeft"> </td><td class="mdescRight">Experimental, to be deprecated. <a href="#a4799eec87ef7d336d0f5db95d273e432">More...</a><br /></td></tr>
- <tr class="separator:a4799eec87ef7d336d0f5db95d273e432"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a4d10732684bd9ace89303dd746adfb96"><td class="memItemLeft" align="right" valign="top">std::vector< <a class="el" href="classgrpc_1_1_server_builder_option.html">ServerBuilderOption</a> * > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_builder.html#a4d10732684bd9ace89303dd746adfb96">options</a> ()</td></tr>
- <tr class="memdesc:a4d10732684bd9ace89303dd746adfb96"><td class="mdescLeft"> </td><td class="mdescRight">Experimental, to be deprecated. <a href="#a4d10732684bd9ace89303dd746adfb96">More...</a><br /></td></tr>
- <tr class="separator:a4d10732684bd9ace89303dd746adfb96"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
- Friends</h2></td></tr>
- <tr class="memitem:a6d051c774efa6448928d2ca4062676d0"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_builder.html#a6d051c774efa6448928d2ca4062676d0">::grpc::testing::ServerBuilderPluginTest</a></td></tr>
- <tr class="separator:a6d051c774efa6448928d2ca4062676d0"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <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>
- </div><h2 class="groupheader">Member Typedef Documentation</h2>
- <a id="a3d9114a66c038daad94f379161209242"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a3d9114a66c038daad94f379161209242">◆ </a></span>HostString</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">typedef std::unique_ptr<<a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a>> <a class="el" href="classgrpc_1_1_server_builder.html#a3d9114a66c038daad94f379161209242">grpc::ServerBuilder::HostString</a></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">protected</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Experimental, to be deprecated. </p>
- </div>
- </div>
- <h2 class="groupheader">Member Enumeration Documentation</h2>
- <a id="aff66bd93cba7d4240a64550fe1fca88d"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aff66bd93cba7d4240a64550fe1fca88d">◆ </a></span>SyncServerOption</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">enum <a class="el" href="classgrpc_1_1_server_builder.html#aff66bd93cba7d4240a64550fe1fca88d">grpc::ServerBuilder::SyncServerOption</a></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Options for synchronous servers. </p>
- <table class="fieldtable">
- <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="aff66bd93cba7d4240a64550fe1fca88da9514f2add3875fc14c843f6498dc1319"></a>NUM_CQS </td><td class="fielddoc"><p>Number of completion queues. </p>
- </td></tr>
- <tr><td class="fieldname"><a id="aff66bd93cba7d4240a64550fe1fca88da74d9b7562f58282d93a3a0e5fb02ab02"></a>MIN_POLLERS </td><td class="fielddoc"><p>Minimum number of polling threads. </p>
- </td></tr>
- <tr><td class="fieldname"><a id="aff66bd93cba7d4240a64550fe1fca88da3b9b382bb2f70cabe793e3e3fd325910"></a>MAX_POLLERS </td><td class="fielddoc"><p>Maximum number of polling threads. </p>
- </td></tr>
- <tr><td class="fieldname"><a id="aff66bd93cba7d4240a64550fe1fca88dad9d34ee45d9bdf2344c6463deea14f4c"></a>CQ_TIMEOUT_MSEC </td><td class="fielddoc"><p>Completion queue timeout in milliseconds. </p>
- </td></tr>
- </table>
- </div>
- </div>
- <h2 class="groupheader">Constructor & Destructor Documentation</h2>
- <a id="a208346e343cd01351492f0cace59b242"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a208346e343cd01351492f0cace59b242">◆ </a></span>ServerBuilder()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">grpc::ServerBuilder::ServerBuilder </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a0bf5d1d50d4e5522ba90bc0efcf91b19"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a0bf5d1d50d4e5522ba90bc0efcf91b19">◆ </a></span>~ServerBuilder()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual grpc::ServerBuilder::~ServerBuilder </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <h2 class="groupheader">Member Function Documentation</h2>
- <a id="aefdac3407920a99d119c946d255b100c"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aefdac3407920a99d119c946d255b100c">◆ </a></span>AddChannelArgument()</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class T > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a>& grpc::ServerBuilder::AddChannelArgument </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> & </td>
- <td class="paramname"><em>arg</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const T & </td>
- <td class="paramname"><em>value</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Add a channel argument (an escape hatch to tuning core library parameters directly) </p>
- </div>
- </div>
- <a id="a960d55977e1aef56fd7b582037a01bbd"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a960d55977e1aef56fd7b582037a01bbd">◆ </a></span>AddCompletionQueue()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">std::unique_ptr<<a class="el" href="classgrpc_1_1_server_completion_queue.html">ServerCompletionQueue</a>> grpc::ServerBuilder::AddCompletionQueue </td>
- <td>(</td>
- <td class="paramtype">bool </td>
- <td class="paramname"><em>is_frequently_polled</em> = <code>true</code></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Add a completion queue for handling asynchronous services. </p>
- <p>Best performance is typically obtained by using one thread per polling completion queue.</p>
- <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>
- <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>
- <p>// While shutting down the server; server_->Shutdown(); cq_->Shutdown(); // Always <em>after</em> the associated server's Shutdown()! // Drain the cq_ that was created void* ignored_tag; bool ignored_ok; while (cq_->Next(&ignored_tag, &ignored_ok)) { }</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <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>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a id="a5bf2d8c40e6b4ca170b9ee927d4db326"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a5bf2d8c40e6b4ca170b9ee927d4db326">◆ </a></span>AddListeningPort()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a>& grpc::ServerBuilder::AddListeningPort </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> & </td>
- <td class="paramname"><em>addr_uri</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">std::shared_ptr< <a class="el" href="classgrpc_1_1_server_credentials.html">ServerCredentials</a> > </td>
- <td class="paramname"><em>creds</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int * </td>
- <td class="paramname"><em>selected_port</em> = <code>nullptr</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- <p>It can be invoked multiple times.</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <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., [::]:<port>, which also accepts IPv4 connections. Valid values include dns:///localhost:1234, / 192.168.1.1:31416, dns:///[::1]:27182, etc.). </td></tr>
- <tr><td class="paramname">creds</td><td>The credentials associated with the server. </td></tr>
- <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>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a id="aa3966340091070dd68fa831a03e1e6ef"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aa3966340091070dd68fa831a03e1e6ef">◆ </a></span>BuildAndStart()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual std::unique_ptr<<a class="el" href="classgrpc_1_1_server.html">Server</a>> grpc::ServerBuilder::BuildAndStart </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Return a running server which is ready for processing calls. </p>
- <p>Before calling, one typically needs to ensure that:</p><ol type="1">
- <li>a service is registered - so that the server knows what to serve (via RegisterService, or RegisterAsyncGenericService)</li>
- <li>a listening port has been added - so the server knows where to receive traffic (via AddListeningPort)</li>
- <li>[for async api only] completion queues have been added via AddCompletionQueue </li>
- </ol>
- </div>
- </div>
- <a id="a01715acec890fe4ddc91340bae5ead8c"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a01715acec890fe4ddc91340bae5ead8c">◆ </a></span>EnableWorkaround()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a>& grpc::ServerBuilder::EnableWorkaround </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="workaround__list_8h.html#ade8be35fce7415c7234ac22d8b9ad9d2">grpc_workaround_list</a> </td>
- <td class="paramname"><em>id</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Enable a server workaround. </p>
- <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>
- </div>
- </div>
- <a id="ae37fe433154b148b9ea9ccb17ac1488a"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ae37fe433154b148b9ea9ccb17ac1488a">◆ </a></span>InternalAddPluginFactory()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">static void grpc::ServerBuilder::InternalAddPluginFactory </td>
- <td>(</td>
- <td class="paramtype">std::unique_ptr< <a class="el" href="classgrpc_1_1_server_builder_plugin.html">ServerBuilderPlugin</a> >(*)() </td>
- <td class="paramname"><em>CreatePlugin</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">static</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>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>
- </div>
- </div>
- <a id="a4d10732684bd9ace89303dd746adfb96"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a4d10732684bd9ace89303dd746adfb96">◆ </a></span>options()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">std::vector<<a class="el" href="classgrpc_1_1_server_builder_option.html">ServerBuilderOption</a>*> grpc::ServerBuilder::options </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Experimental, to be deprecated. </p>
- </div>
- </div>
- <a id="a5826774e7c803998238a74ef43b5c811"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a5826774e7c803998238a74ef43b5c811">◆ </a></span>ports()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">std::vector<<a class="el" href="structgrpc_1_1_server_builder_1_1_port.html">Port</a>> grpc::ServerBuilder::ports </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Experimental, to be deprecated. </p>
- </div>
- </div>
- <a id="a06468091b05b8bba676a0b94ca8e1281"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a06468091b05b8bba676a0b94ca8e1281">◆ </a></span>RegisterAsyncGenericService()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a>& grpc::ServerBuilder::RegisterAsyncGenericService </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="classgrpc_1_1_async_generic_service.html">AsyncGenericService</a> * </td>
- <td class="paramname"><em>service</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Register a generic service. </p>
- <p>Matches requests with any :authority This is mostly useful for writing generic gRPC Proxies where the exact serialization format is unknown </p>
- </div>
- </div>
- <a id="a5300484238239412a11e0a9c49435d7e"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a5300484238239412a11e0a9c49435d7e">◆ </a></span>RegisterService() <span class="overload">[1/2]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a>& grpc::ServerBuilder::RegisterService </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="classgrpc_1_1_service.html">Service</a> * </td>
- <td class="paramname"><em>service</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Register a service. </p>
- <p>This call does not take ownership of the service. The service must exist for the lifetime of the <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>
- </div>
- </div>
- <a id="a0b06b5828b892feeb6541c8eeae2d542"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a0b06b5828b892feeb6541c8eeae2d542">◆ </a></span>RegisterService() <span class="overload">[2/2]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a>& grpc::ServerBuilder::RegisterService </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> & </td>
- <td class="paramname"><em>host</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="classgrpc_1_1_service.html">Service</a> * </td>
- <td class="paramname"><em>service</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Register a service. </p>
- <p>This call does not take ownership of the service. The service must exist for the lifetime of the <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>
- </div>
- </div>
- <a id="a4799eec87ef7d336d0f5db95d273e432"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a4799eec87ef7d336d0f5db95d273e432">◆ </a></span>services()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">std::vector<<a class="el" href="structgrpc_1_1_server_builder_1_1_named_service.html">NamedService</a>*> grpc::ServerBuilder::services </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Experimental, to be deprecated. </p>
- </div>
- </div>
- <a id="a26e4b20a377c4bbbe37c33aa72165034"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a26e4b20a377c4bbbe37c33aa72165034">◆ </a></span>SetCompressionAlgorithmSupportStatus()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a>& grpc::ServerBuilder::SetCompressionAlgorithmSupportStatus </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="compression__types_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a> </td>
- <td class="paramname"><em>algorithm</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">bool </td>
- <td class="paramname"><em>enabled</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Set the support status for compression algorithms. </p>
- <p>All algorithms are enabled by default.</p>
- <p>Incoming calls compressed with an unsupported algorithm will fail with <em>GRPC_STATUS_UNIMPLEMENTED</em>. </p>
- </div>
- </div>
- <a id="a6ee516b7445ff4e1274a6d882f529504"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a6ee516b7445ff4e1274a6d882f529504">◆ </a></span>SetDefaultCompressionAlgorithm()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a>& grpc::ServerBuilder::SetDefaultCompressionAlgorithm </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="compression__types_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a> </td>
- <td class="paramname"><em>algorithm</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>The default compression algorithm to use for all channel calls in the absence of a call-specific level. </p>
- <p>Note that it overrides any compression level set by <em>SetDefaultCompressionLevel</em>. </p>
- </div>
- </div>
- <a id="ae10c6dc23ec295695710c0b4c14f9353"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ae10c6dc23ec295695710c0b4c14f9353">◆ </a></span>SetDefaultCompressionLevel()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a>& grpc::ServerBuilder::SetDefaultCompressionLevel </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="compression__types_8h.html#a14a79ed6b5ebd7e1dda7c2684f499cc7">grpc_compression_level</a> </td>
- <td class="paramname"><em>level</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>The default compression level to use for all channel calls in the absence of a call-specific level. </p>
- </div>
- </div>
- <a id="a13f4b030529c9f447e3a172a6d8a7e29"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a13f4b030529c9f447e3a172a6d8a7e29">◆ </a></span>SetMaxMessageSize()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a>& grpc::ServerBuilder::SetMaxMessageSize </td>
- <td>(</td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>max_message_size</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000002">Deprecated:</a></b></dt><dd>For backward compatibility. </dd></dl>
- </div>
- </div>
- <a id="ab5c8a420f2acfc6fcea2f2210e9d426e"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ab5c8a420f2acfc6fcea2f2210e9d426e">◆ </a></span>SetMaxReceiveMessageSize()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a>& grpc::ServerBuilder::SetMaxReceiveMessageSize </td>
- <td>(</td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>max_receive_message_size</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Set max receive message size in bytes. </p>
- </div>
- </div>
- <a id="ac6deb0d17c9439febcd04f813fec8a05"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ac6deb0d17c9439febcd04f813fec8a05">◆ </a></span>SetMaxSendMessageSize()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a>& grpc::ServerBuilder::SetMaxSendMessageSize </td>
- <td>(</td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>max_send_message_size</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Set max send message size in bytes. </p>
- </div>
- </div>
- <a id="af0480c82eb5881f6d998ff85abe0c99a"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#af0480c82eb5881f6d998ff85abe0c99a">◆ </a></span>SetOption()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a>& grpc::ServerBuilder::SetOption </td>
- <td>(</td>
- <td class="paramtype">std::unique_ptr< <a class="el" href="classgrpc_1_1_server_builder_option.html">ServerBuilderOption</a> > </td>
- <td class="paramname"><em>option</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="acf8de0a3b6a99a32a6c52328eaaebf23"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#acf8de0a3b6a99a32a6c52328eaaebf23">◆ </a></span>SetResourceQuota()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a>& grpc::ServerBuilder::SetResourceQuota </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="classgrpc_1_1_resource_quota.html">ResourceQuota</a> & </td>
- <td class="paramname"><em>resource_quota</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Set the attached buffer pool for this server. </p>
- </div>
- </div>
- <a id="acbc2a859672203e7be097de55e296d4b"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#acbc2a859672203e7be097de55e296d4b">◆ </a></span>SetSyncServerOption()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a>& grpc::ServerBuilder::SetSyncServerOption </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="classgrpc_1_1_server_builder.html#aff66bd93cba7d4240a64550fe1fca88d">SyncServerOption</a> </td>
- <td class="paramname"><em>option</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>value</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Only useful if this is a Synchronous server. </p>
- </div>
- </div>
- <h2 class="groupheader">Friends And Related Function Documentation</h2>
- <a id="a6d051c774efa6448928d2ca4062676d0"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a6d051c774efa6448928d2ca4062676d0">◆ </a></span>::grpc::testing::ServerBuilderPluginTest</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">friend class ::grpc::testing::ServerBuilderPluginTest</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">friend</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <h2 class="groupheader">Field Documentation</h2>
- <a id="a27b5a3733140caef60846fc21977d6ba"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a27b5a3733140caef60846fc21977d6ba">◆ </a></span>algorithm</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="compression__types_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a> grpc::ServerBuilder::algorithm</td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="ab2b0b337e27ae80796675a3dd224ec3a"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ab2b0b337e27ae80796675a3dd224ec3a">◆ </a></span>is_set</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">bool grpc::ServerBuilder::is_set</td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a99bc7fd30172c4e154b6942e1c221a1c"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a99bc7fd30172c4e154b6942e1c221a1c">◆ </a></span>level</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="compression__types_8h.html#a14a79ed6b5ebd7e1dda7c2684f499cc7">grpc_compression_level</a> grpc::ServerBuilder::level</td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <hr/>The documentation for this class was generated from the following file:<ul>
- <li>include/grpcpp/<a class="el" href="grpcpp_2server__builder_8h_source.html">server_builder.h</a></li>
- </ul>
- </div><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated on Tue May 15 2018 17:01:01 for GRPC C++ by  <a href="http://www.doxygen.org/index.html">
- <img class="footer" src="doxygen.png" alt="doxygen"/>
- </a> 1.8.13
- </small></address>
- </body>
- </html>
|