grpcpp_2impl_2server__builder__option_8h_source.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>GRPC C++: include/grpcpp/impl/server_builder_option.h Source File</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. </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.36.1</span>
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.8.17 -->
  34. <script type="text/javascript">
  35. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. /* @license-end */
  38. </script>
  39. <script type="text/javascript" src="menudata.js"></script>
  40. <script type="text/javascript" src="menu.js"></script>
  41. <script type="text/javascript">
  42. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  43. $(function() {
  44. initMenu('',true,false,'search.php','Search');
  45. $(document).ready(function() { init_search(); });
  46. });
  47. /* @license-end */</script>
  48. <div id="main-nav"></div>
  49. <!-- window showing the filter options -->
  50. <div id="MSearchSelectWindow"
  51. onmouseover="return searchBox.OnSearchSelectShow()"
  52. onmouseout="return searchBox.OnSearchSelectHide()"
  53. onkeydown="return searchBox.OnSearchSelectKey(event)">
  54. </div>
  55. <!-- iframe showing the search results (closed by default) -->
  56. <div id="MSearchResultsWindow">
  57. <iframe src="javascript:void(0)" frameborder="0"
  58. name="MSearchResults" id="MSearchResults">
  59. </iframe>
  60. </div>
  61. <div id="nav-path" class="navpath">
  62. <ul>
  63. <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_412f9a3d5dfcba8716486cd870ef4586.html">grpcpp</a></li><li class="navelem"><a class="el" href="dir_84040d6f573b73aa8d12512b533ede11.html">impl</a></li> </ul>
  64. </div>
  65. </div><!-- top -->
  66. <div class="header">
  67. <div class="headertitle">
  68. <div class="title">server_builder_option.h</div> </div>
  69. </div><!--header-->
  70. <div class="contents">
  71. <a href="grpcpp_2impl_2server__builder__option_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div>
  72. <div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> *</span></div>
  73. <div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * Copyright 2015 gRPC authors.</span></div>
  74. <div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> *</span></div>
  75. <div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div>
  76. <div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * you may not use this file except in compliance with the License.</span></div>
  77. <div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * You may obtain a copy of the License at</span></div>
  78. <div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> *</span></div>
  79. <div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div>
  80. <div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> *</span></div>
  81. <div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div>
  82. <div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div>
  83. <div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
  84. <div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> * See the License for the specific language governing permissions and</span></div>
  85. <div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> * limitations under the License.</span></div>
  86. <div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> *</span></div>
  87. <div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment"> */</span></div>
  88. <div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; </div>
  89. <div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#ifndef GRPCPP_IMPL_SERVER_BUILDER_OPTION_H</span></div>
  90. <div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#define GRPCPP_IMPL_SERVER_BUILDER_OPTION_H</span></div>
  91. <div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; </div>
  92. <div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#include &lt;map&gt;</span></div>
  93. <div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &lt;memory&gt;</span></div>
  94. <div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; </div>
  95. <div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="grpcpp_2impl_2server__builder__plugin_8h.html">grpcpp/impl/server_builder_plugin.h</a>&gt;</span></div>
  96. <div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="grpcpp_2support_2channel__arguments_8h.html">grpcpp/support/channel_arguments.h</a>&gt;</span></div>
  97. <div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; </div>
  98. <div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacegrpc.html">grpc</a> {</div>
  99. <div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; </div>
  100. <div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="classgrpc_1_1_server_builder_option.html"> 31</a></span>&#160;<span class="keyword">class </span><a class="code" href="classgrpc_1_1_server_builder_option.html">ServerBuilderOption</a> {</div>
  101. <div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <span class="keyword">public</span>:</div>
  102. <div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="classgrpc_1_1_server_builder_option.html#aa0a884edb26d286e0d56b867a0cf928c"> 33</a></span>&#160; <span class="keyword">virtual</span> <a class="code" href="classgrpc_1_1_server_builder_option.html#aa0a884edb26d286e0d56b867a0cf928c">~ServerBuilderOption</a>() {}</div>
  103. <div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classgrpc_1_1_server_builder_option.html#a132394317bdda21a184de14aeb75876d">UpdateArguments</a>(<a class="code" href="classgrpc_1_1_channel_arguments.html">grpc::ChannelArguments</a>* args) = 0;</div>
  104. <div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classgrpc_1_1_server_builder_option.html#a5879a733eef508e8d93ab1061a97aa06">UpdatePlugins</a>(</div>
  105. <div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; std::vector&lt;std::unique_ptr&lt;grpc::ServerBuilderPlugin&gt;&gt;* plugins) = 0;</div>
  106. <div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;};</div>
  107. <div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; </div>
  108. <div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;} <span class="comment">// namespace grpc</span></div>
  109. <div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; </div>
  110. <div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="preprocessor">#endif // GRPCPP_IMPL_SERVER_BUILDER_OPTION_H</span></div>
  111. </div><!-- fragment --></div><!-- contents -->
  112. <div class="ttc" id="aclassgrpc_1_1_server_builder_option_html"><div class="ttname"><a href="classgrpc_1_1_server_builder_option.html">grpc::ServerBuilderOption</a></div><div class="ttdoc">Interface to pass an option to a ServerBuilder.</div><div class="ttdef"><b>Definition:</b> server_builder_option.h:31</div></div>
  113. <div class="ttc" id="anamespacegrpc_html"><div class="ttname"><a href="namespacegrpc.html">grpc</a></div><div class="ttdoc">An Alarm posts the user-provided tag to its associated completion queue or invokes the user-provided ...</div><div class="ttdef"><b>Definition:</b> alarm.h:33</div></div>
  114. <div class="ttc" id="aclassgrpc_1_1_server_builder_option_html_a132394317bdda21a184de14aeb75876d"><div class="ttname"><a href="classgrpc_1_1_server_builder_option.html#a132394317bdda21a184de14aeb75876d">grpc::ServerBuilderOption::UpdateArguments</a></div><div class="ttdeci">virtual void UpdateArguments(grpc::ChannelArguments *args)=0</div><div class="ttdoc">Alter the ChannelArguments used to create the gRPC server.</div></div>
  115. <div class="ttc" id="aclassgrpc_1_1_server_builder_option_html_a5879a733eef508e8d93ab1061a97aa06"><div class="ttname"><a href="classgrpc_1_1_server_builder_option.html#a5879a733eef508e8d93ab1061a97aa06">grpc::ServerBuilderOption::UpdatePlugins</a></div><div class="ttdeci">virtual void UpdatePlugins(std::vector&lt; std::unique_ptr&lt; grpc::ServerBuilderPlugin &gt;&gt; *plugins)=0</div><div class="ttdoc">Alter the ServerBuilderPlugin map that will be added into ServerBuilder.</div></div>
  116. <div class="ttc" id="aclassgrpc_1_1_channel_arguments_html"><div class="ttname"><a href="classgrpc_1_1_channel_arguments.html">grpc::ChannelArguments</a></div><div class="ttdoc">Options for channel creation.</div><div class="ttdef"><b>Definition:</b> channel_arguments.h:39</div></div>
  117. <div class="ttc" id="agrpcpp_2impl_2server__builder__plugin_8h_html"><div class="ttname"><a href="grpcpp_2impl_2server__builder__plugin_8h.html">server_builder_plugin.h</a></div></div>
  118. <div class="ttc" id="agrpcpp_2support_2channel__arguments_8h_html"><div class="ttname"><a href="grpcpp_2support_2channel__arguments_8h.html">channel_arguments.h</a></div></div>
  119. <div class="ttc" id="aclassgrpc_1_1_server_builder_option_html_aa0a884edb26d286e0d56b867a0cf928c"><div class="ttname"><a href="classgrpc_1_1_server_builder_option.html#aa0a884edb26d286e0d56b867a0cf928c">grpc::ServerBuilderOption::~ServerBuilderOption</a></div><div class="ttdeci">virtual ~ServerBuilderOption()</div><div class="ttdef"><b>Definition:</b> server_builder_option.h:33</div></div>
  120. <!-- start footer part -->
  121. <hr class="footer"/><address class="footer"><small>
  122. Generated on Wed Mar 3 2021 19:17:19 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  123. <img class="footer" src="doxygen.png" alt="doxygen"/>
  124. </a> 1.8.17
  125. </small></address>
  126. </body>
  127. </html>