carto
/
grpc


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GRPC C++: grpc::ServerBuilderPlugin 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" />
</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.36.1</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</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_plugin.html">ServerBuilderPlugin</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">grpc::ServerBuilderPlugin Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
</div><!--header-->
<div class="contents">

<p>This interface is meant for internal usage only.  
 <a href="classgrpc_1_1_server_builder_plugin.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="grpcpp_2impl_2server__builder__plugin_8h_source.html">server_builder_plugin.h</a>&gt;</code></p>
<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:a00ed34821232736bc11777215412386f"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_builder_plugin.html#a00ed34821232736bc11777215412386f">~ServerBuilderPlugin</a> ()</td></tr>
<tr class="separator:a00ed34821232736bc11777215412386f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a131f0b1df0c60e92b9c78d8fefc0c489"><td class="memItemLeft" align="right" valign="top">virtual std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_builder_plugin.html#a131f0b1df0c60e92b9c78d8fefc0c489">name</a> ()=0</td></tr>
<tr class="separator:a131f0b1df0c60e92b9c78d8fefc0c489"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af2c62bcc75c28da6b7edc9680e1aab3e"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_builder_plugin.html#af2c62bcc75c28da6b7edc9680e1aab3e">UpdateServerBuilder</a> (<a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a> *)</td></tr>
<tr class="memdesc:af2c62bcc75c28da6b7edc9680e1aab3e"><td class="mdescLeft">&#160;</td><td class="mdescRight">UpdateServerBuilder will be called at an early stage in <a class="el" href="classgrpc_1_1_server_builder.html#a3ad1429e6575de79f8f17dad383fbc04" title="Return a running server which is ready for processing calls.">ServerBuilder::BuildAndStart()</a>, right after the ServerBuilderOptions have done their updates.  <a href="classgrpc_1_1_server_builder_plugin.html#af2c62bcc75c28da6b7edc9680e1aab3e">More...</a><br /></td></tr>
<tr class="separator:af2c62bcc75c28da6b7edc9680e1aab3e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aae901e058799d699f029fd80f05b46d1"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_builder_plugin.html#aae901e058799d699f029fd80f05b46d1">InitServer</a> (<a class="el" href="classgrpc_1_1_server_initializer.html">ServerInitializer</a> *si)=0</td></tr>
<tr class="memdesc:aae901e058799d699f029fd80f05b46d1"><td class="mdescLeft">&#160;</td><td class="mdescRight">InitServer will be called in <a class="el" href="classgrpc_1_1_server_builder.html#a3ad1429e6575de79f8f17dad383fbc04" title="Return a running server which is ready for processing calls.">ServerBuilder::BuildAndStart()</a>, after the <a class="el" href="classgrpc_1_1_server.html" title="Represents a gRPC server.">Server</a> instance is created.  <a href="classgrpc_1_1_server_builder_plugin.html#aae901e058799d699f029fd80f05b46d1">More...</a><br /></td></tr>
<tr class="separator:aae901e058799d699f029fd80f05b46d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2b70dd8ff457f4e47c4d23acada5bed9"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_builder_plugin.html#a2b70dd8ff457f4e47c4d23acada5bed9">Finish</a> (<a class="el" href="classgrpc_1_1_server_initializer.html">ServerInitializer</a> *si)=0</td></tr>
<tr class="memdesc:a2b70dd8ff457f4e47c4d23acada5bed9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Finish will be called at the end of <a class="el" href="classgrpc_1_1_server_builder.html#a3ad1429e6575de79f8f17dad383fbc04" title="Return a running server which is ready for processing calls.">ServerBuilder::BuildAndStart()</a>.  <a href="classgrpc_1_1_server_builder_plugin.html#a2b70dd8ff457f4e47c4d23acada5bed9">More...</a><br /></td></tr>
<tr class="separator:a2b70dd8ff457f4e47c4d23acada5bed9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2ab82b76728b0f768d7a9fca9c0f3726"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_builder_plugin.html#a2ab82b76728b0f768d7a9fca9c0f3726">ChangeArguments</a> (const std::string &amp;<a class="el" href="classgrpc_1_1_server_builder_plugin.html#a131f0b1df0c60e92b9c78d8fefc0c489">name</a>, void *value)=0</td></tr>
<tr class="memdesc:a2ab82b76728b0f768d7a9fca9c0f3726"><td class="mdescLeft">&#160;</td><td class="mdescRight">ChangeArguments is an interface that can be used in <a class="el" href="classgrpc_1_1_server_builder_option.html#a5879a733eef508e8d93ab1061a97aa06" title="Alter the ServerBuilderPlugin map that will be added into ServerBuilder.">ServerBuilderOption::UpdatePlugins</a>.  <a href="classgrpc_1_1_server_builder_plugin.html#a2ab82b76728b0f768d7a9fca9c0f3726">More...</a><br /></td></tr>
<tr class="separator:a2ab82b76728b0f768d7a9fca9c0f3726"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab35664c3aee1a67f369b7e0ccb2c9419"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_builder_plugin.html#ab35664c3aee1a67f369b7e0ccb2c9419">UpdateChannelArguments</a> (<a class="el" href="classgrpc_1_1_channel_arguments.html">ChannelArguments</a> *)</td></tr>
<tr class="memdesc:ab35664c3aee1a67f369b7e0ccb2c9419"><td class="mdescLeft">&#160;</td><td class="mdescRight">UpdateChannelArguments will be called in <a class="el" href="classgrpc_1_1_server_builder.html#a3ad1429e6575de79f8f17dad383fbc04" title="Return a running server which is ready for processing calls.">ServerBuilder::BuildAndStart()</a>, before the <a class="el" href="classgrpc_1_1_server.html" title="Represents a gRPC server.">Server</a> instance is created.  <a href="classgrpc_1_1_server_builder_plugin.html#ab35664c3aee1a67f369b7e0ccb2c9419">More...</a><br /></td></tr>
<tr class="separator:ab35664c3aee1a67f369b7e0ccb2c9419"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a89727883dd80f7a5f8e3d07e7df13f28"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_builder_plugin.html#a89727883dd80f7a5f8e3d07e7df13f28">has_sync_methods</a> () const</td></tr>
<tr class="separator:a89727883dd80f7a5f8e3d07e7df13f28"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3b62f84342dec96521e69071d9a63988"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_builder_plugin.html#a3b62f84342dec96521e69071d9a63988">has_async_methods</a> () const</td></tr>
<tr class="separator:a3b62f84342dec96521e69071d9a63988"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This interface is meant for internal usage only. </p>
<p>Implementations of this interface should add themselves to a <em><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></em> instance through the <em>InternalAddPluginFactory</em> method. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a00ed34821232736bc11777215412386f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a00ed34821232736bc11777215412386f">&#9670;&nbsp;</a></span>~ServerBuilderPlugin()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual grpc::ServerBuilderPlugin::~ServerBuilderPlugin </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">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a2ab82b76728b0f768d7a9fca9c0f3726"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2ab82b76728b0f768d7a9fca9c0f3726">&#9670;&nbsp;</a></span>ChangeArguments()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void grpc::ServerBuilderPlugin::ChangeArguments </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>name</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>value</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>ChangeArguments is an interface that can be used in <a class="el" href="classgrpc_1_1_server_builder_option.html#a5879a733eef508e8d93ab1061a97aa06" title="Alter the ServerBuilderPlugin map that will be added into ServerBuilder.">ServerBuilderOption::UpdatePlugins</a>. </p>

</div>
</div>
<a id="a2b70dd8ff457f4e47c4d23acada5bed9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2b70dd8ff457f4e47c4d23acada5bed9">&#9670;&nbsp;</a></span>Finish()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void grpc::ServerBuilderPlugin::Finish </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classgrpc_1_1_server_initializer.html">ServerInitializer</a> *&#160;</td>
          <td class="paramname"><em>si</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Finish will be called at the end of <a class="el" href="classgrpc_1_1_server_builder.html#a3ad1429e6575de79f8f17dad383fbc04" title="Return a running server which is ready for processing calls.">ServerBuilder::BuildAndStart()</a>. </p>

</div>
</div>
<a id="a3b62f84342dec96521e69071d9a63988"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3b62f84342dec96521e69071d9a63988">&#9670;&nbsp;</a></span>has_async_methods()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool grpc::ServerBuilderPlugin::has_async_methods </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="a89727883dd80f7a5f8e3d07e7df13f28"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a89727883dd80f7a5f8e3d07e7df13f28">&#9670;&nbsp;</a></span>has_sync_methods()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool grpc::ServerBuilderPlugin::has_sync_methods </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="aae901e058799d699f029fd80f05b46d1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aae901e058799d699f029fd80f05b46d1">&#9670;&nbsp;</a></span>InitServer()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void grpc::ServerBuilderPlugin::InitServer </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classgrpc_1_1_server_initializer.html">ServerInitializer</a> *&#160;</td>
          <td class="paramname"><em>si</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>InitServer will be called in <a class="el" href="classgrpc_1_1_server_builder.html#a3ad1429e6575de79f8f17dad383fbc04" title="Return a running server which is ready for processing calls.">ServerBuilder::BuildAndStart()</a>, after the <a class="el" href="classgrpc_1_1_server.html" title="Represents a gRPC server.">Server</a> instance is created. </p>

</div>
</div>
<a id="a131f0b1df0c60e92b9c78d8fefc0c489"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a131f0b1df0c60e92b9c78d8fefc0c489">&#9670;&nbsp;</a></span>name()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual std::string grpc::ServerBuilderPlugin::name </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="ab35664c3aee1a67f369b7e0ccb2c9419"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab35664c3aee1a67f369b7e0ccb2c9419">&#9670;&nbsp;</a></span>UpdateChannelArguments()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void grpc::ServerBuilderPlugin::UpdateChannelArguments </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classgrpc_1_1_channel_arguments.html">ChannelArguments</a> *&#160;</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">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>UpdateChannelArguments will be called in <a class="el" href="classgrpc_1_1_server_builder.html#a3ad1429e6575de79f8f17dad383fbc04" title="Return a running server which is ready for processing calls.">ServerBuilder::BuildAndStart()</a>, before the <a class="el" href="classgrpc_1_1_server.html" title="Represents a gRPC server.">Server</a> instance is created. </p>

</div>
</div>
<a id="af2c62bcc75c28da6b7edc9680e1aab3e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af2c62bcc75c28da6b7edc9680e1aab3e">&#9670;&nbsp;</a></span>UpdateServerBuilder()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void grpc::ServerBuilderPlugin::UpdateServerBuilder </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a> *&#160;</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">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>UpdateServerBuilder will be called at an early stage in <a class="el" href="classgrpc_1_1_server_builder.html#a3ad1429e6575de79f8f17dad383fbc04" title="Return a running server which is ready for processing calls.">ServerBuilder::BuildAndStart()</a>, right after the ServerBuilderOptions have done their updates. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/grpcpp/impl/<a class="el" href="grpcpp_2impl_2server__builder__plugin_8h_source.html">server_builder_plugin.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Mar 3 2021 19:17:25 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>