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

268 lines
12 KiB
HTML
Raw 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::MetadataCredentialsPlugin 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.58.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_metadata_credentials_plugin.html">MetadataCredentialsPlugin</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::MetadataCredentialsPlugin Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>User defined metadata credentials.
<a href="classgrpc_1_1_metadata_credentials_plugin.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:aa0f8c6fc458bf81c3d3384e84ad7059e"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_metadata_credentials_plugin.html#aa0f8c6fc458bf81c3d3384e84ad7059e">~MetadataCredentialsPlugin</a> ()</td></tr>
<tr class="separator:aa0f8c6fc458bf81c3d3384e84ad7059e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6faf44f7c08d0311a38a868fdb8cbaf0"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_metadata_credentials_plugin.html#a6faf44f7c08d0311a38a868fdb8cbaf0">IsBlocking</a> () const</td></tr>
<tr class="memdesc:a6faf44f7c08d0311a38a868fdb8cbaf0"><td class="mdescLeft">&#160;</td><td class="mdescRight">If this method returns true, the Process function will be scheduled in a different thread from the one processing the call. <a href="classgrpc_1_1_metadata_credentials_plugin.html#a6faf44f7c08d0311a38a868fdb8cbaf0">More...</a><br /></td></tr>
<tr class="separator:a6faf44f7c08d0311a38a868fdb8cbaf0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad9a7f5fb8a373bf3680938511cedaf7c"><td class="memItemLeft" align="right" valign="top">virtual const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_metadata_credentials_plugin.html#ad9a7f5fb8a373bf3680938511cedaf7c">GetType</a> () const</td></tr>
<tr class="memdesc:ad9a7f5fb8a373bf3680938511cedaf7c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type of credentials this plugin is implementing. <a href="classgrpc_1_1_metadata_credentials_plugin.html#ad9a7f5fb8a373bf3680938511cedaf7c">More...</a><br /></td></tr>
<tr class="separator:ad9a7f5fb8a373bf3680938511cedaf7c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae6e9664ee51d6490e64c4755734ab16d"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classgrpc_1_1_status.html">grpc::Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_metadata_credentials_plugin.html#ae6e9664ee51d6490e64c4755734ab16d">GetMetadata</a> (<a class="el" href="classgrpc_1_1string__ref.html">grpc::string_ref</a> service_url, <a class="el" href="classgrpc_1_1string__ref.html">grpc::string_ref</a> method_name, const <a class="el" href="classgrpc_1_1_auth_context.html">grpc::AuthContext</a> &amp;channel_auth_context, std::multimap&lt; grpc::string, grpc::string &gt; *metadata)=0</td></tr>
<tr class="memdesc:ae6e9664ee51d6490e64c4755734ab16d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the auth metatada produced by this plugin. <a href="classgrpc_1_1_metadata_credentials_plugin.html#ae6e9664ee51d6490e64c4755734ab16d">More...</a><br /></td></tr>
<tr class="separator:ae6e9664ee51d6490e64c4755734ab16d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a010de34e9e4240af3529e8913456bec2"><td class="memItemLeft" align="right" valign="top">virtual grpc::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_metadata_credentials_plugin.html#a010de34e9e4240af3529e8913456bec2">DebugString</a> ()</td></tr>
<tr class="separator:a010de34e9e4240af3529e8913456bec2"><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>User defined metadata credentials. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="aa0f8c6fc458bf81c3d3384e84ad7059e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa0f8c6fc458bf81c3d3384e84ad7059e">&#9670;&nbsp;</a></span>~MetadataCredentialsPlugin()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual grpc::MetadataCredentialsPlugin::~MetadataCredentialsPlugin </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="a010de34e9e4240af3529e8913456bec2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a010de34e9e4240af3529e8913456bec2">&#9670;&nbsp;</a></span>DebugString()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual grpc::string grpc::MetadataCredentialsPlugin::DebugString </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>
<a id="ae6e9664ee51d6490e64c4755734ab16d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae6e9664ee51d6490e64c4755734ab16d">&#9670;&nbsp;</a></span>GetMetadata()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classgrpc_1_1_status.html">grpc::Status</a> grpc::MetadataCredentialsPlugin::GetMetadata </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classgrpc_1_1string__ref.html">grpc::string_ref</a>&#160;</td>
<td class="paramname"><em>service_url</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classgrpc_1_1string__ref.html">grpc::string_ref</a>&#160;</td>
<td class="paramname"><em>method_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classgrpc_1_1_auth_context.html">grpc::AuthContext</a> &amp;&#160;</td>
<td class="paramname"><em>channel_auth_context</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::multimap&lt; grpc::string, grpc::string &gt; *&#160;</td>
<td class="paramname"><em>metadata</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>Gets the auth metatada produced by this plugin. </p>
<p>The fully qualified method name is: service_url + "/" + method_name. The channel_auth_context contains (among other things), the identity of the server. </p>
</div>
</div>
<a id="ad9a7f5fb8a373bf3680938511cedaf7c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad9a7f5fb8a373bf3680938511cedaf7c">&#9670;&nbsp;</a></span>GetType()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const char* grpc::MetadataCredentialsPlugin::GetType </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">
<p>Type of credentials this plugin is implementing. </p>
</div>
</div>
<a id="a6faf44f7c08d0311a38a868fdb8cbaf0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6faf44f7c08d0311a38a868fdb8cbaf0">&#9670;&nbsp;</a></span>IsBlocking()</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::MetadataCredentialsPlugin::IsBlocking </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">
<p>If this method returns true, the Process function will be scheduled in a different thread from the one processing the call. </p>
</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 Wed Sep 6 2023 16:09: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