natas_hw
/
grpc
0
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
grpc/cpp/classgrpc_1_1_call_credenti...

299 lines
14 KiB
HTML
Raw Permalink Blame History

<!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::CallCredentials 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.64.0</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_call_credentials.html">CallCredentials</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#friends">Friends</a> </div>
<div class="headertitle">
<div class="title">grpc::CallCredentials Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A call credentials object encapsulates the state needed by a client to authenticate with a server for a given call on a channel.
<a href="classgrpc_1_1_call_credentials.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="grpcpp_2security_2credentials_8h_source.html">credentials.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:af2e0b2a8110e08c867b88f29da9df94a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_call_credentials.html#af2e0b2a8110e08c867b88f29da9df94a">~CallCredentials</a> () override</td></tr>
<tr class="separator:af2e0b2a8110e08c867b88f29da9df94a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1aa37d0e5dd03be8e01b0cf28c4ff538"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_call_credentials.html#a1aa37d0e5dd03be8e01b0cf28c4ff538">ApplyToCall</a> (<a class="el" href="grpc__types_8h.html#a122f8f4f0a585396d993d9b55848f222">grpc_call</a> *call)</td></tr>
<tr class="memdesc:a1aa37d0e5dd03be8e01b0cf28c4ff538"><td class="mdescLeft">&#160;</td><td class="mdescRight">Apply this instance's credentials to <em>call</em>. <a href="classgrpc_1_1_call_credentials.html#a1aa37d0e5dd03be8e01b0cf28c4ff538">More...</a><br /></td></tr>
<tr class="separator:a1aa37d0e5dd03be8e01b0cf28c4ff538"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae5d0c5a43fa1a62e36f02dd6bcaad0c3"><td class="memItemLeft" align="right" valign="top">grpc::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_call_credentials.html#ae5d0c5a43fa1a62e36f02dd6bcaad0c3">DebugString</a> ()</td></tr>
<tr class="separator:ae5d0c5a43fa1a62e36f02dd6bcaad0c3"><td class="memSeparator" colspan="2">&#160;</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:a2cc55f8d298ef767410eec459ea10f5d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_call_credentials.html#a2cc55f8d298ef767410eec459ea10f5d">CallCredentials</a> (<a class="el" href="grpc_2credentials_8h.html#a2350ef1b38c4f69d0ff8510dcbe40072">grpc_call_credentials</a> *creds)</td></tr>
<tr class="separator:a2cc55f8d298ef767410eec459ea10f5d"><td class="memSeparator" colspan="2">&#160;</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:a5d68f01318c95ecfb5816cb74d72e66e"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_call_credentials.html#a5d68f01318c95ecfb5816cb74d72e66e">CompositeCallCredentialsImpl</a></td></tr>
<tr class="separator:a5d68f01318c95ecfb5816cb74d72e66e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab603d68f9c9387554aa756b27b6b7359"><td class="memItemLeft" align="right" valign="top">std::shared_ptr&lt; <a class="el" href="classgrpc_1_1_channel_credentials.html">ChannelCredentials</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_call_credentials.html#ab603d68f9c9387554aa756b27b6b7359">CompositeChannelCredentials</a> (const std::shared_ptr&lt; <a class="el" href="classgrpc_1_1_channel_credentials.html">ChannelCredentials</a> &gt; &amp;channel_creds, const std::shared_ptr&lt; <a class="el" href="classgrpc_1_1_call_credentials.html">CallCredentials</a> &gt; &amp;call_creds)</td></tr>
<tr class="memdesc:ab603d68f9c9387554aa756b27b6b7359"><td class="mdescLeft">&#160;</td><td class="mdescRight">Combines a channel credentials and a call credentials into a composite channel credentials. <a href="classgrpc_1_1_call_credentials.html#ab603d68f9c9387554aa756b27b6b7359">More...</a><br /></td></tr>
<tr class="separator:ab603d68f9c9387554aa756b27b6b7359"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aad68cd62e39577dd16e14125454a3820"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_call_credentials.html#aad68cd62e39577dd16e14125454a3820">grpc::testing::GetOauth2AccessToken</a> ()</td></tr>
<tr class="separator:aad68cd62e39577dd16e14125454a3820"><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>A call credentials object encapsulates the state needed by a client to authenticate with a server for a given call on a 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 &amp; Destructor Documentation</h2>
<a id="af2e0b2a8110e08c867b88f29da9df94a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af2e0b2a8110e08c867b88f29da9df94a">&#9670;&nbsp;</a></span>~CallCredentials()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">grpc::CallCredentials::~CallCredentials </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a2cc55f8d298ef767410eec459ea10f5d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2cc55f8d298ef767410eec459ea10f5d">&#9670;&nbsp;</a></span>CallCredentials()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">grpc::CallCredentials::CallCredentials </td>
<td>(</td>
<td class="paramtype"><a class="el" href="grpc_2credentials_8h.html#a2350ef1b38c4f69d0ff8510dcbe40072">grpc_call_credentials</a> *&#160;</td>
<td class="paramname"><em>creds</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a1aa37d0e5dd03be8e01b0cf28c4ff538"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1aa37d0e5dd03be8e01b0cf28c4ff538">&#9670;&nbsp;</a></span>ApplyToCall()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool grpc::CallCredentials::ApplyToCall </td>
<td>(</td>
<td class="paramtype"><a class="el" href="grpc__types_8h.html#a122f8f4f0a585396d993d9b55848f222">grpc_call</a> *&#160;</td>
<td class="paramname"><em>call</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Apply this instance's credentials to <em>call</em>. </p>
</div>
</div>
<a id="ae5d0c5a43fa1a62e36f02dd6bcaad0c3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae5d0c5a43fa1a62e36f02dd6bcaad0c3">&#9670;&nbsp;</a></span>DebugString()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">grpc::string grpc::CallCredentials::DebugString </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a id="a5d68f01318c95ecfb5816cb74d72e66e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5d68f01318c95ecfb5816cb74d72e66e">&#9670;&nbsp;</a></span>CompositeCallCredentialsImpl</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">friend class CompositeCallCredentialsImpl</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="ab603d68f9c9387554aa756b27b6b7359"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab603d68f9c9387554aa756b27b6b7359">&#9670;&nbsp;</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&lt;<a class="el" href="classgrpc_1_1_channel_credentials.html">ChannelCredentials</a>&gt; CompositeChannelCredentials </td>
<td>(</td>
<td class="paramtype">const std::shared_ptr&lt; <a class="el" href="classgrpc_1_1_channel_credentials.html">ChannelCredentials</a> &gt; &amp;&#160;</td>
<td class="paramname"><em>channel_creds</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::shared_ptr&lt; <a class="el" href="classgrpc_1_1_call_credentials.html">CallCredentials</a> &gt; &amp;&#160;</td>
<td class="paramname"><em>call_creds</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">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="aad68cd62e39577dd16e14125454a3820"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aad68cd62e39577dd16e14125454a3820">&#9670;&nbsp;</a></span>grpc::testing::GetOauth2AccessToken</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string <a class="el" href="namespacegrpc_1_1testing.html#a6041b40abd8b76b388dadb43bd8ee0d4">grpc::testing::GetOauth2AccessToken</a> </td>
<td>(</td>
<td class="paramname"></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="grpcpp_2security_2credentials_8h_source.html">credentials.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri May 17 2024 01:17:16 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>
Reference in New Issue View Git Blame Copy Permalink