| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307 |
- <!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_impl::experimental Namespace 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++
-  <span id="projectnumber">1.22.0</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__impl.html">grpc_impl</a></li><li class="navelem"><a class="el" href="namespacegrpc__impl_1_1experimental.html">experimental</a></li> </ul>
- </div>
- </div><!-- top -->
- <div class="header">
- <div class="summary">
- <a href="#nested-classes">Data Structures</a> |
- <a href="#func-members">Functions</a> </div>
- <div class="headertitle">
- <div class="title">grpc_impl::experimental Namespace Reference</div> </div>
- </div><!--header-->
- <div class="contents">
- <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__impl_1_1experimental_1_1_alts_credentials_options.html">AltsCredentialsOptions</a></td></tr>
- <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Options used to build AltsCredentials. <a href="structgrpc__impl_1_1experimental_1_1_alts_credentials_options.html#details">More...</a><br /></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__impl_1_1experimental_1_1_alts_server_credentials_options.html">AltsServerCredentialsOptions</a></td></tr>
- <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Options to create <a class="el" href="classgrpc__impl_1_1_server_credentials.html" title="Wrapper around grpc_server_credentials, a way to authenticate a server. ">ServerCredentials</a> with ALTS. <a href="structgrpc__impl_1_1experimental_1_1_alts_server_credentials_options.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="func-members"></a>
- Functions</h2></td></tr>
- <tr class="memitem:a48c141a4c0a991fd94bcd455e9392492"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegrpc__impl_1_1experimental.html#a48c141a4c0a991fd94bcd455e9392492">ChannelResetConnectionBackoff</a> (<a class="el" href="classgrpc__impl_1_1_channel.html">Channel</a> *channel)</td></tr>
- <tr class="memdesc:a48c141a4c0a991fd94bcd455e9392492"><td class="mdescLeft"> </td><td class="mdescRight">Resets the channel's connection backoff. <a href="#a48c141a4c0a991fd94bcd455e9392492">More...</a><br /></td></tr>
- <tr class="separator:a48c141a4c0a991fd94bcd455e9392492"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a9c746351c2dfd50ca78d7929c66e2a89"><td class="memItemLeft" align="right" valign="top">std::shared_ptr<::<a class="el" href="namespacegrpc.html#a3c981ec4941ef822eb01ac99da53ca88">grpc::Channel</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegrpc__impl_1_1experimental.html#a9c746351c2dfd50ca78d7929c66e2a89">CreateCustomChannelWithInterceptors</a> (const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &target, const std::shared_ptr< <a class="el" href="namespacegrpc.html#aaf2939b1b4a48aa00606f8e986bf21de">grpc::ChannelCredentials</a> > &creds, const ::<a class="el" href="namespacegrpc.html#a0fb985b4797b9d239bc8164ed1bad223">grpc::ChannelArguments</a> &args, std::vector< std::unique_ptr< <a class="el" href="classgrpc_1_1experimental_1_1_client_interceptor_factory_interface.html">grpc::experimental::ClientInterceptorFactoryInterface</a> >> interceptor_creators)</td></tr>
- <tr class="memdesc:a9c746351c2dfd50ca78d7929c66e2a89"><td class="mdescLeft"> </td><td class="mdescRight">Create a new <em>custom</em> <em><a class="el" href="classgrpc__impl_1_1_channel.html" title="Channels represent a connection to an endpoint. Created by CreateChannel. ">Channel</a></em> pointing to <em>target</em> with <em>interceptors</em> being invoked per call. <a href="#a9c746351c2dfd50ca78d7929c66e2a89">More...</a><br /></td></tr>
- <tr class="separator:a9c746351c2dfd50ca78d7929c66e2a89"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:acb04406cf950918fa509dccf2030f6d8"><td class="memItemLeft" align="right" valign="top">std::shared_ptr<::<a class="el" href="namespacegrpc.html#a3c981ec4941ef822eb01ac99da53ca88">grpc::Channel</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegrpc__impl_1_1experimental.html#acb04406cf950918fa509dccf2030f6d8">CreateCustomChannelWithInterceptors</a> (const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &target, const std::shared_ptr< <a class="el" href="classgrpc__impl_1_1_channel_credentials.html">ChannelCredentials</a> > &creds, const <a class="el" href="namespacegrpc.html#a0fb985b4797b9d239bc8164ed1bad223">grpc::ChannelArguments</a> &args, std::vector< std::unique_ptr< <a class="el" href="classgrpc_1_1experimental_1_1_client_interceptor_factory_interface.html">grpc::experimental::ClientInterceptorFactoryInterface</a> >> interceptor_creators)</td></tr>
- <tr class="separator:acb04406cf950918fa509dccf2030f6d8"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a451bdb10d6605054a44c6dc39b233ddc"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classgrpc__impl_1_1_channel_credentials.html">ChannelCredentials</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegrpc__impl_1_1experimental.html#a451bdb10d6605054a44c6dc39b233ddc">AltsCredentials</a> (const <a class="el" href="structgrpc__impl_1_1experimental_1_1_alts_credentials_options.html">AltsCredentialsOptions</a> &options)</td></tr>
- <tr class="memdesc:a451bdb10d6605054a44c6dc39b233ddc"><td class="mdescLeft"> </td><td class="mdescRight">Builds ALTS Credentials given ALTS specific options. <a href="#a451bdb10d6605054a44c6dc39b233ddc">More...</a><br /></td></tr>
- <tr class="separator:a451bdb10d6605054a44c6dc39b233ddc"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a64ae0296aed5117e1eb5c48bbed67604"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classgrpc__impl_1_1_channel_credentials.html">ChannelCredentials</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegrpc__impl_1_1experimental.html#a64ae0296aed5117e1eb5c48bbed67604">LocalCredentials</a> (<a class="el" href="grpc__security__constants_8h.html#a31d00ce5c064e1fff4261a6d6298dc11">grpc_local_connect_type</a> type)</td></tr>
- <tr class="memdesc:a64ae0296aed5117e1eb5c48bbed67604"><td class="mdescLeft"> </td><td class="mdescRight">Builds Local Credentials. <a href="#a64ae0296aed5117e1eb5c48bbed67604">More...</a><br /></td></tr>
- <tr class="separator:a64ae0296aed5117e1eb5c48bbed67604"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:abf04d0563b8351571af5cb044495682d"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classgrpc__impl_1_1_server_credentials.html">ServerCredentials</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegrpc__impl_1_1experimental.html#abf04d0563b8351571af5cb044495682d">AltsServerCredentials</a> (const <a class="el" href="structgrpc__impl_1_1experimental_1_1_alts_server_credentials_options.html">AltsServerCredentialsOptions</a> &options)</td></tr>
- <tr class="memdesc:abf04d0563b8351571af5cb044495682d"><td class="mdescLeft"> </td><td class="mdescRight">Builds ALTS <a class="el" href="classgrpc__impl_1_1_server_credentials.html" title="Wrapper around grpc_server_credentials, a way to authenticate a server. ">ServerCredentials</a> given ALTS specific options. <a href="#abf04d0563b8351571af5cb044495682d">More...</a><br /></td></tr>
- <tr class="separator:abf04d0563b8351571af5cb044495682d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a805a7a560cf296b9e4b0156c29c32458"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classgrpc__impl_1_1_server_credentials.html">ServerCredentials</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegrpc__impl_1_1experimental.html#a805a7a560cf296b9e4b0156c29c32458">LocalServerCredentials</a> (<a class="el" href="grpc__security__constants_8h.html#a31d00ce5c064e1fff4261a6d6298dc11">grpc_local_connect_type</a> type)</td></tr>
- <tr class="memdesc:a805a7a560cf296b9e4b0156c29c32458"><td class="mdescLeft"> </td><td class="mdescRight">Builds Local <a class="el" href="classgrpc__impl_1_1_server_credentials.html" title="Wrapper around grpc_server_credentials, a way to authenticate a server. ">ServerCredentials</a>. <a href="#a805a7a560cf296b9e4b0156c29c32458">More...</a><br /></td></tr>
- <tr class="separator:a805a7a560cf296b9e4b0156c29c32458"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <h2 class="groupheader">Function Documentation</h2>
- <a id="a451bdb10d6605054a44c6dc39b233ddc"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a451bdb10d6605054a44c6dc39b233ddc">◆ </a></span>AltsCredentials()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">std::shared_ptr<<a class="el" href="classgrpc__impl_1_1_channel_credentials.html">ChannelCredentials</a>> grpc_impl::experimental::AltsCredentials </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="structgrpc__impl_1_1experimental_1_1_alts_credentials_options.html">AltsCredentialsOptions</a> & </td>
- <td class="paramname"><em>options</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Builds ALTS Credentials given ALTS specific options. </p>
- </div>
- </div>
- <a id="abf04d0563b8351571af5cb044495682d"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#abf04d0563b8351571af5cb044495682d">◆ </a></span>AltsServerCredentials()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">std::shared_ptr<<a class="el" href="classgrpc__impl_1_1_server_credentials.html">ServerCredentials</a>> grpc_impl::experimental::AltsServerCredentials </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="structgrpc__impl_1_1experimental_1_1_alts_server_credentials_options.html">AltsServerCredentialsOptions</a> & </td>
- <td class="paramname"><em>options</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Builds ALTS <a class="el" href="classgrpc__impl_1_1_server_credentials.html" title="Wrapper around grpc_server_credentials, a way to authenticate a server. ">ServerCredentials</a> given ALTS specific options. </p>
- </div>
- </div>
- <a id="a48c141a4c0a991fd94bcd455e9392492"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a48c141a4c0a991fd94bcd455e9392492">◆ </a></span>ChannelResetConnectionBackoff()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void grpc_impl::experimental::ChannelResetConnectionBackoff </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="classgrpc__impl_1_1_channel.html">Channel</a> * </td>
- <td class="paramname"><em>channel</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Resets the channel's connection backoff. </p>
- <p>TODO(roth): Once we see whether this proves useful, either create a gRFC and change this to be a method of the <a class="el" href="classgrpc__impl_1_1_channel.html" title="Channels represent a connection to an endpoint. Created by CreateChannel. ">Channel</a> class, or remove it. </p>
- </div>
- </div>
- <a id="acb04406cf950918fa509dccf2030f6d8"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#acb04406cf950918fa509dccf2030f6d8">◆ </a></span>CreateCustomChannelWithInterceptors() <span class="overload">[1/2]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">std::shared_ptr<::<a class="el" href="namespacegrpc.html#a3c981ec4941ef822eb01ac99da53ca88">grpc::Channel</a>> grpc_impl::experimental::CreateCustomChannelWithInterceptors </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> & </td>
- <td class="paramname"><em>target</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const std::shared_ptr< <a class="el" href="classgrpc__impl_1_1_channel_credentials.html">ChannelCredentials</a> > & </td>
- <td class="paramname"><em>creds</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const <a class="el" href="namespacegrpc.html#a0fb985b4797b9d239bc8164ed1bad223">grpc::ChannelArguments</a> & </td>
- <td class="paramname"><em>args</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">std::vector< std::unique_ptr< <a class="el" href="classgrpc_1_1experimental_1_1_client_interceptor_factory_interface.html">grpc::experimental::ClientInterceptorFactoryInterface</a> >> </td>
- <td class="paramname"><em>interceptor_creators</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a9c746351c2dfd50ca78d7929c66e2a89"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a9c746351c2dfd50ca78d7929c66e2a89">◆ </a></span>CreateCustomChannelWithInterceptors() <span class="overload">[2/2]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">std::shared_ptr<::<a class="el" href="namespacegrpc.html#a3c981ec4941ef822eb01ac99da53ca88">grpc::Channel</a>> grpc_impl::experimental::CreateCustomChannelWithInterceptors </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> & </td>
- <td class="paramname"><em>target</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const std::shared_ptr< <a class="el" href="namespacegrpc.html#aaf2939b1b4a48aa00606f8e986bf21de">grpc::ChannelCredentials</a> > & </td>
- <td class="paramname"><em>creds</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const ::<a class="el" href="namespacegrpc.html#a0fb985b4797b9d239bc8164ed1bad223">grpc::ChannelArguments</a> & </td>
- <td class="paramname"><em>args</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">std::vector< std::unique_ptr< <a class="el" href="classgrpc_1_1experimental_1_1_client_interceptor_factory_interface.html">grpc::experimental::ClientInterceptorFactoryInterface</a> >> </td>
- <td class="paramname"><em>interceptor_creators</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Create a new <em>custom</em> <em><a class="el" href="classgrpc__impl_1_1_channel.html" title="Channels represent a connection to an endpoint. Created by CreateChannel. ">Channel</a></em> pointing to <em>target</em> with <em>interceptors</em> being invoked per call. </p>
- <dl class="section warning"><dt>Warning</dt><dd>For advanced use and testing ONLY. Override default channel arguments only if necessary.</dd></dl>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">target</td><td>The URI of the endpoint to connect to. </td></tr>
- <tr><td class="paramname">creds</td><td>Credentials to use for the created channel. If it does not hold an object or is invalid, a lame channel (one on which all operations fail) is returned. </td></tr>
- <tr><td class="paramname">args</td><td>Options for channel creation. </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a id="a64ae0296aed5117e1eb5c48bbed67604"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a64ae0296aed5117e1eb5c48bbed67604">◆ </a></span>LocalCredentials()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">std::shared_ptr<<a class="el" href="classgrpc__impl_1_1_channel_credentials.html">ChannelCredentials</a>> grpc_impl::experimental::LocalCredentials </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="grpc__security__constants_8h.html#a31d00ce5c064e1fff4261a6d6298dc11">grpc_local_connect_type</a> </td>
- <td class="paramname"><em>type</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Builds Local Credentials. </p>
- </div>
- </div>
- <a id="a805a7a560cf296b9e4b0156c29c32458"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a805a7a560cf296b9e4b0156c29c32458">◆ </a></span>LocalServerCredentials()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">std::shared_ptr<<a class="el" href="classgrpc__impl_1_1_server_credentials.html">ServerCredentials</a>> grpc_impl::experimental::LocalServerCredentials </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="grpc__security__constants_8h.html#a31d00ce5c064e1fff4261a6d6298dc11">grpc_local_connect_type</a> </td>
- <td class="paramname"><em>type</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Builds Local <a class="el" href="classgrpc__impl_1_1_server_credentials.html" title="Wrapper around grpc_server_credentials, a way to authenticate a server. ">ServerCredentials</a>. </p>
- </div>
- </div>
- </div><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated on Wed Jul 3 2019 14:51:27 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>
|