308 lines
16 KiB
HTML
308 lines
16 KiB
HTML
<!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::ChannelCredentials 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++
|
||
 <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="classgrpc__impl_1_1_channel_credentials.html">ChannelCredentials</a></li> </ul>
|
||
</div>
|
||
</div><!-- top -->
|
||
<div class="header">
|
||
<div class="summary">
|
||
<a href="#pub-methods">Public Member Functions</a> |
|
||
<a href="#pro-methods">Protected Member Functions</a> |
|
||
<a href="#friends">Friends</a> </div>
|
||
<div class="headertitle">
|
||
<div class="title">grpc_impl::ChannelCredentials Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
|
||
</div><!--header-->
|
||
<div class="contents">
|
||
|
||
<p>A channel credentials object encapsulates all the state needed by a client to authenticate with a server for a given channel.
|
||
<a href="classgrpc__impl_1_1_channel_credentials.html#details">More...</a></p>
|
||
|
||
<p><code>#include <<a class="el" href="credentials__impl_8h_source.html">credentials_impl.h</a>></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:a16a7cdd9af04de6f1ac349208a03df72"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_channel_credentials.html#a16a7cdd9af04de6f1ac349208a03df72">ChannelCredentials</a> ()</td></tr>
|
||
<tr class="separator:a16a7cdd9af04de6f1ac349208a03df72"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a12a27fe88f826cac1e6db7a54967f6b5"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_channel_credentials.html#a12a27fe88f826cac1e6db7a54967f6b5">~ChannelCredentials</a> ()</td></tr>
|
||
<tr class="separator:a12a27fe88f826cac1e6db7a54967f6b5"><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:a4699bf27d3b181fed110afbca4bb9d16"><td class="memItemLeft" align="right" valign="top">virtual SecureChannelCredentials * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_channel_credentials.html#a4699bf27d3b181fed110afbca4bb9d16">AsSecureCredentials</a> ()=0</td></tr>
|
||
<tr class="separator:a4699bf27d3b181fed110afbca4bb9d16"><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:ab603d68f9c9387554aa756b27b6b7359"><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="classgrpc__impl_1_1_channel_credentials.html#ab603d68f9c9387554aa756b27b6b7359">CompositeChannelCredentials</a> (const std::shared_ptr< <a class="el" href="classgrpc__impl_1_1_channel_credentials.html">ChannelCredentials</a> > &channel_creds, const std::shared_ptr< <a class="el" href="classgrpc__impl_1_1_call_credentials.html">CallCredentials</a> > &call_creds)</td></tr>
|
||
<tr class="memdesc:ab603d68f9c9387554aa756b27b6b7359"><td class="mdescLeft"> </td><td class="mdescRight">Combines a channel credentials and a call credentials into a composite channel credentials. <a href="#ab603d68f9c9387554aa756b27b6b7359">More...</a><br /></td></tr>
|
||
<tr class="separator:ab603d68f9c9387554aa756b27b6b7359"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a85beb9c5f15cb86b3ea55404d62ba243"><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="classgrpc__impl_1_1_channel_credentials.html#a85beb9c5f15cb86b3ea55404d62ba243">CreateCustomChannelImpl</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)</td></tr>
|
||
<tr class="separator:a85beb9c5f15cb86b3ea55404d62ba243"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a2aa0e8e3223ccc9025dd106156de738f"><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="classgrpc__impl_1_1_channel_credentials.html#a2aa0e8e3223ccc9025dd106156de738f">grpc_impl::experimental::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:a2aa0e8e3223ccc9025dd106156de738f"><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 channel credentials object encapsulates all the state needed by a client to authenticate with a server for a given channel. </p>
|
||
<p>It can make various assertions, e.g., about the client’s identity, role for all the calls on that channel.</p>
|
||
<dl class="section see"><dt>See also</dt><dd><a href="https://grpc.io/docs/guides/auth.html">https://grpc.io/docs/guides/auth.html</a> </dd></dl>
|
||
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
||
<a id="a16a7cdd9af04de6f1ac349208a03df72"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a16a7cdd9af04de6f1ac349208a03df72">◆ </a></span>ChannelCredentials()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">grpc_impl::ChannelCredentials::ChannelCredentials </td>
|
||
<td>(</td>
|
||
<td class="paramname"></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a12a27fe88f826cac1e6db7a54967f6b5"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a12a27fe88f826cac1e6db7a54967f6b5">◆ </a></span>~ChannelCredentials()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">grpc_impl::ChannelCredentials::~ChannelCredentials </td>
|
||
<td>(</td>
|
||
<td class="paramname"></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
</div>
|
||
</div>
|
||
<h2 class="groupheader">Member Function Documentation</h2>
|
||
<a id="a4699bf27d3b181fed110afbca4bb9d16"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a4699bf27d3b181fed110afbca4bb9d16">◆ </a></span>AsSecureCredentials()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">virtual SecureChannelCredentials* grpc_impl::ChannelCredentials::AsSecureCredentials </td>
|
||
<td>(</td>
|
||
<td class="paramname"></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
<td class="mlabels-right">
|
||
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span> </td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
</div>
|
||
</div>
|
||
<h2 class="groupheader">Friends And Related Function Documentation</h2>
|
||
<a id="ab603d68f9c9387554aa756b27b6b7359"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ab603d68f9c9387554aa756b27b6b7359">◆ </a></span>CompositeChannelCredentials</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">std::shared_ptr<<a class="el" href="classgrpc__impl_1_1_channel_credentials.html">ChannelCredentials</a>> CompositeChannelCredentials </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>channel_creds</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_call_credentials.html">CallCredentials</a> > & </td>
|
||
<td class="paramname"><em>call_creds</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">friend</span></span> </td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Combines a channel credentials and a call credentials into a composite channel credentials. </p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a85beb9c5f15cb86b3ea55404d62ba243"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a85beb9c5f15cb86b3ea55404d62ba243">◆ </a></span>CreateCustomChannelImpl</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">std::shared_ptr<::<a class="el" href="namespacegrpc.html#a3c981ec4941ef822eb01ac99da53ca88">grpc::Channel</a>> CreateCustomChannelImpl </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></td>
|
||
<td>)</td>
|
||
<td></td><td></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>
|
||
<a id="a2aa0e8e3223ccc9025dd106156de738f"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a2aa0e8e3223ccc9025dd106156de738f">◆ </a></span>grpc_impl::experimental::CreateCustomChannelWithInterceptors</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">std::shared_ptr<::<a class="el" href="namespacegrpc.html#a3c981ec4941ef822eb01ac99da53ca88">grpc::Channel</a>> <a class="el" href="namespacegrpc__impl_1_1experimental.html#a9c746351c2dfd50ca78d7929c66e2a89">grpc_impl::experimental::CreateCustomChannelWithInterceptors</a> </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>
|
||
</td>
|
||
<td class="mlabels-right">
|
||
<span class="mlabels"><span class="mlabel">friend</span></span> </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/security/<a class="el" href="credentials__impl_8h_source.html">credentials_impl.h</a></li>
|
||
</ul>
|
||
</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>
|