carto
/
grpc


			
				
					
						
						
							12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394
							<!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++: include/grpcpp/impl/server_builder_plugin.h Source File</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++
   &#160;<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="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>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">server_builder_plugin.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="grpcpp_2impl_2server__builder__plugin_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><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> * Copyright 2016 gRPC authors.</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> *</span></div><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><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><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><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> *</span></div><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><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"> *</span></div><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><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><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><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><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"> * limitations under the License.</span></div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;</div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="preprocessor">#ifndef GRPCPP_IMPL_SERVER_BUILDER_PLUGIN_H</span></div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="preprocessor">#define GRPCPP_IMPL_SERVER_BUILDER_PLUGIN_H</span></div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;</div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="preprocessor">#include &lt;memory&gt;</span></div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;</div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="grpcpp_2support_2config_8h.html">grpcpp/support/config.h</a>&gt;</span></div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;</div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacegrpc.html">grpc</a> {</div><div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;</div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="keyword">class </span>ServerBuilder;</div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="keyword">class </span>ServerInitializer;</div><div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="keyword">class </span>ChannelArguments;</div><div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;</div><div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="classgrpc_1_1_server_builder_plugin.html">   35</a></span>&#160;<span class="keyword">class </span><a class="code" href="classgrpc_1_1_server_builder_plugin.html">ServerBuilderPlugin</a> {</div><div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="classgrpc_1_1_server_builder_plugin.html#a00ed34821232736bc11777215412386f">   37</a></span>&#160;  <span class="keyword">virtual</span> <a class="code" href="classgrpc_1_1_server_builder_plugin.html#a00ed34821232736bc11777215412386f">~ServerBuilderPlugin</a>() {}</div><div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;  <span class="keyword">virtual</span> <a class="code" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> <a class="code" href="classgrpc_1_1_server_builder_plugin.html#ac337c61dcb4d6c41e669e510f1faca48">name</a>() = 0;</div><div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;</div><div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="classgrpc_1_1_server_builder_plugin.html#a9d3d5be23a10ea272aeb11118233147d">   42</a></span>&#160;  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classgrpc_1_1_server_builder_plugin.html#a9d3d5be23a10ea272aeb11118233147d">UpdateServerBuilder</a>(<a class="code" href="classgrpc_1_1_server_builder.html">ServerBuilder</a>* builder) {}</div><div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;</div><div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classgrpc_1_1_server_builder_plugin.html#aae901e058799d699f029fd80f05b46d1">InitServer</a>(<a class="code" href="classgrpc_1_1_server_initializer.html">ServerInitializer</a>* si) = 0;</div><div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;</div><div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classgrpc_1_1_server_builder_plugin.html#a2b70dd8ff457f4e47c4d23acada5bed9">Finish</a>(<a class="code" href="classgrpc_1_1_server_initializer.html">ServerInitializer</a>* si) = 0;</div><div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;</div><div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classgrpc_1_1_server_builder_plugin.html#af1a9c6d18ab78065f7e755b61a778635">ChangeArguments</a>(<span class="keyword">const</span> <a class="code" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a>&amp; <a class="code" href="classgrpc_1_1_server_builder_plugin.html#ac337c61dcb4d6c41e669e510f1faca48">name</a>, <span class="keywordtype">void</span>* value) = 0;</div><div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;</div><div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="classgrpc_1_1_server_builder_plugin.html#a616e24edf3859bb1feb9ec1d4db8dbe7">   57</a></span>&#160;  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classgrpc_1_1_server_builder_plugin.html#a616e24edf3859bb1feb9ec1d4db8dbe7">UpdateChannelArguments</a>(<a class="code" href="classgrpc_1_1_channel_arguments.html">ChannelArguments</a>* args) {}</div><div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;</div><div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="classgrpc_1_1_server_builder_plugin.html#a89727883dd80f7a5f8e3d07e7df13f28">   59</a></span>&#160;  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classgrpc_1_1_server_builder_plugin.html#a89727883dd80f7a5f8e3d07e7df13f28">has_sync_methods</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="keyword">false</span>; }</div><div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="classgrpc_1_1_server_builder_plugin.html#a3b62f84342dec96521e69071d9a63988">   60</a></span>&#160;  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classgrpc_1_1_server_builder_plugin.html#a3b62f84342dec96521e69071d9a63988">has_async_methods</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="keyword">false</span>; }</div><div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;};</div><div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;</div><div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;}  <span class="comment">// namespace grpc</span></div><div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;</div><div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;<span class="preprocessor">#endif  // GRPCPP_IMPL_SERVER_BUILDER_PLUGIN_H</span></div><div class="ttc" id="namespacegrpc_html_ab04a87625da3bf85cdaf5e7856b00203"><div class="ttname"><a href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a></div><div class="ttdeci">std::string string</div><div class="ttdef"><b>Definition:</b> config.h:35</div></div>
<div class="ttc" id="classgrpc_1_1_server_builder_plugin_html_a00ed34821232736bc11777215412386f"><div class="ttname"><a href="classgrpc_1_1_server_builder_plugin.html#a00ed34821232736bc11777215412386f">grpc::ServerBuilderPlugin::~ServerBuilderPlugin</a></div><div class="ttdeci">virtual ~ServerBuilderPlugin()</div><div class="ttdef"><b>Definition:</b> server_builder_plugin.h:37</div></div>
<div class="ttc" id="classgrpc_1_1_server_builder_plugin_html_a3b62f84342dec96521e69071d9a63988"><div class="ttname"><a href="classgrpc_1_1_server_builder_plugin.html#a3b62f84342dec96521e69071d9a63988">grpc::ServerBuilderPlugin::has_async_methods</a></div><div class="ttdeci">virtual bool has_async_methods() const</div><div class="ttdef"><b>Definition:</b> server_builder_plugin.h:60</div></div>
<div class="ttc" id="classgrpc_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>
<div class="ttc" id="classgrpc_1_1_server_builder_plugin_html_a89727883dd80f7a5f8e3d07e7df13f28"><div class="ttname"><a href="classgrpc_1_1_server_builder_plugin.html#a89727883dd80f7a5f8e3d07e7df13f28">grpc::ServerBuilderPlugin::has_sync_methods</a></div><div class="ttdeci">virtual bool has_sync_methods() const</div><div class="ttdef"><b>Definition:</b> server_builder_plugin.h:59</div></div>
<div class="ttc" id="classgrpc_1_1_server_initializer_html"><div class="ttname"><a href="classgrpc_1_1_server_initializer.html">grpc::ServerInitializer</a></div><div class="ttdef"><b>Definition:</b> server_initializer.h:32</div></div>
<div class="ttc" id="classgrpc_1_1_server_builder_plugin_html_aae901e058799d699f029fd80f05b46d1"><div class="ttname"><a href="classgrpc_1_1_server_builder_plugin.html#aae901e058799d699f029fd80f05b46d1">grpc::ServerBuilderPlugin::InitServer</a></div><div class="ttdeci">virtual void InitServer(ServerInitializer *si)=0</div><div class="ttdoc">InitServer will be called in ServerBuilder::BuildAndStart(), after the Server instance is created...</div></div>
<div class="ttc" id="classgrpc_1_1_server_builder_plugin_html_af1a9c6d18ab78065f7e755b61a778635"><div class="ttname"><a href="classgrpc_1_1_server_builder_plugin.html#af1a9c6d18ab78065f7e755b61a778635">grpc::ServerBuilderPlugin::ChangeArguments</a></div><div class="ttdeci">virtual void ChangeArguments(const grpc::string &amp;name, void *value)=0</div><div class="ttdoc">ChangeArguments is an interface that can be used in ServerBuilderOption::UpdatePlugins. </div></div>
<div class="ttc" id="classgrpc_1_1_server_builder_plugin_html_a616e24edf3859bb1feb9ec1d4db8dbe7"><div class="ttname"><a href="classgrpc_1_1_server_builder_plugin.html#a616e24edf3859bb1feb9ec1d4db8dbe7">grpc::ServerBuilderPlugin::UpdateChannelArguments</a></div><div class="ttdeci">virtual void UpdateChannelArguments(ChannelArguments *args)</div><div class="ttdoc">UpdateChannelArguments will be called in ServerBuilder::BuildAndStart(), before the Server instance i...</div><div class="ttdef"><b>Definition:</b> server_builder_plugin.h:57</div></div>
<div class="ttc" id="namespacegrpc_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 upon expiry or cancellation...</div><div class="ttdef"><b>Definition:</b> alarm.h:31</div></div>
<div class="ttc" id="classgrpc_1_1_server_builder_plugin_html_ac337c61dcb4d6c41e669e510f1faca48"><div class="ttname"><a href="classgrpc_1_1_server_builder_plugin.html#ac337c61dcb4d6c41e669e510f1faca48">grpc::ServerBuilderPlugin::name</a></div><div class="ttdeci">virtual grpc::string name()=0</div></div>
<div class="ttc" id="grpcpp_2support_2config_8h_html"><div class="ttname"><a href="grpcpp_2support_2config_8h.html">config.h</a></div></div>
<div class="ttc" id="classgrpc_1_1_server_builder_plugin_html_a9d3d5be23a10ea272aeb11118233147d"><div class="ttname"><a href="classgrpc_1_1_server_builder_plugin.html#a9d3d5be23a10ea272aeb11118233147d">grpc::ServerBuilderPlugin::UpdateServerBuilder</a></div><div class="ttdeci">virtual void UpdateServerBuilder(ServerBuilder *builder)</div><div class="ttdoc">UpdateServerBuilder will be called at the beginning of ServerBuilder::BuildAndStart(). </div><div class="ttdef"><b>Definition:</b> server_builder_plugin.h:42</div></div>
<div class="ttc" id="classgrpc_1_1_server_builder_plugin_html_a2b70dd8ff457f4e47c4d23acada5bed9"><div class="ttname"><a href="classgrpc_1_1_server_builder_plugin.html#a2b70dd8ff457f4e47c4d23acada5bed9">grpc::ServerBuilderPlugin::Finish</a></div><div class="ttdeci">virtual void Finish(ServerInitializer *si)=0</div><div class="ttdoc">Finish will be called at the end of ServerBuilder::BuildAndStart(). </div></div>
<div class="ttc" id="classgrpc_1_1_server_builder_plugin_html"><div class="ttname"><a href="classgrpc_1_1_server_builder_plugin.html">grpc::ServerBuilderPlugin</a></div><div class="ttdoc">This interface is meant for internal usage only. </div><div class="ttdef"><b>Definition:</b> server_builder_plugin.h:35</div></div>
<div class="ttc" id="classgrpc_1_1_server_builder_html"><div class="ttname"><a href="classgrpc_1_1_server_builder.html">grpc::ServerBuilder</a></div><div class="ttdoc">A builder class for the creation and startup of grpc::Server instances. </div><div class="ttdef"><b>Definition:</b> server_builder.h:52</div></div>
</div><!-- fragment --></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 &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>