carto
/
grpc


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369
							<!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::AuthContext 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" />
<script type="text/javascript"> (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); ga('create', 'UA-60127042-1', 'auto'); ga('send', 'pageview'); </script></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.13.0-dev</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.html">grpc</a></li><li class="navelem"><a class="el" href="classgrpc_1_1_auth_context.html">AuthContext</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::AuthContext Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
</div><!--header-->
<div class="contents">

<p>Class encapsulating the Authentication Information.  
 <a href="classgrpc_1_1_auth_context.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="grpcpp_2impl_2codegen_2security_2auth__context_8h_source.html">auth_context.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:a3784c5f4eeab56a8524da29981548464"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_auth_context.html#a3784c5f4eeab56a8524da29981548464">~AuthContext</a> ()</td></tr>
<tr class="separator:a3784c5f4eeab56a8524da29981548464"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af1d6a5c7cd67694d1a485c4127eb63dc"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_auth_context.html#af1d6a5c7cd67694d1a485c4127eb63dc">IsPeerAuthenticated</a> () const =0</td></tr>
<tr class="memdesc:af1d6a5c7cd67694d1a485c4127eb63dc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if the peer is authenticated.  <a href="#af1d6a5c7cd67694d1a485c4127eb63dc">More...</a><br /></td></tr>
<tr class="separator:af1d6a5c7cd67694d1a485c4127eb63dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a56a84468c1c3814a185cb6a2a3badf99"><td class="memItemLeft" align="right" valign="top">virtual std::vector&lt; <a class="el" href="classgrpc_1_1string__ref.html">grpc::string_ref</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_auth_context.html#a56a84468c1c3814a185cb6a2a3badf99">GetPeerIdentity</a> () const =0</td></tr>
<tr class="memdesc:a56a84468c1c3814a185cb6a2a3badf99"><td class="mdescLeft">&#160;</td><td class="mdescRight">A peer identity.  <a href="#a56a84468c1c3814a185cb6a2a3badf99">More...</a><br /></td></tr>
<tr class="separator:a56a84468c1c3814a185cb6a2a3badf99"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad7b2e589590246b953decd05cdaa4465"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_auth_context.html#ad7b2e589590246b953decd05cdaa4465">GetPeerIdentityPropertyName</a> () const =0</td></tr>
<tr class="separator:ad7b2e589590246b953decd05cdaa4465"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac32b53377f8b7e44328f791f44bd6732"><td class="memItemLeft" align="right" valign="top">virtual std::vector&lt; <a class="el" href="classgrpc_1_1string__ref.html">grpc::string_ref</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_auth_context.html#ac32b53377f8b7e44328f791f44bd6732">FindPropertyValues</a> (const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;name) const =0</td></tr>
<tr class="memdesc:ac32b53377f8b7e44328f791f44bd6732"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns all the property values with the given name.  <a href="#ac32b53377f8b7e44328f791f44bd6732">More...</a><br /></td></tr>
<tr class="separator:ac32b53377f8b7e44328f791f44bd6732"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4a4a9e18e05e1a06cf25b8a77edd8c89"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classgrpc_1_1_auth_property_iterator.html">AuthPropertyIterator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_auth_context.html#a4a4a9e18e05e1a06cf25b8a77edd8c89">begin</a> () const =0</td></tr>
<tr class="memdesc:a4a4a9e18e05e1a06cf25b8a77edd8c89"><td class="mdescLeft">&#160;</td><td class="mdescRight">Iteration over all the properties.  <a href="#a4a4a9e18e05e1a06cf25b8a77edd8c89">More...</a><br /></td></tr>
<tr class="separator:a4a4a9e18e05e1a06cf25b8a77edd8c89"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a81d358b427e0f1096e148918cdeef991"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classgrpc_1_1_auth_property_iterator.html">AuthPropertyIterator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_auth_context.html#a81d358b427e0f1096e148918cdeef991">end</a> () const =0</td></tr>
<tr class="separator:a81d358b427e0f1096e148918cdeef991"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:add9dbb40b1a822f683a7ebad71e774f2"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_auth_context.html#add9dbb40b1a822f683a7ebad71e774f2">AddProperty</a> (const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;key, const <a class="el" href="classgrpc_1_1string__ref.html">grpc::string_ref</a> &amp;value)=0</td></tr>
<tr class="memdesc:add9dbb40b1a822f683a7ebad71e774f2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Mutation functions: should only be used by an <a class="el" href="classgrpc_1_1_auth_metadata_processor.html" title="Interface allowing custom server-side authorization based on credentials encoded in metadata...">AuthMetadataProcessor</a>.  <a href="#add9dbb40b1a822f683a7ebad71e774f2">More...</a><br /></td></tr>
<tr class="separator:add9dbb40b1a822f683a7ebad71e774f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a218158a0698137b9c5d6fff0c8054cc4"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_auth_context.html#a218158a0698137b9c5d6fff0c8054cc4">SetPeerIdentityPropertyName</a> (const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;name)=0</td></tr>
<tr class="separator:a218158a0698137b9c5d6fff0c8054cc4"><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>Class encapsulating the Authentication Information. </p>
<p>It includes the secure identity of the peer, the type of secure transport used as well as any other properties required by the authorization layer. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a3784c5f4eeab56a8524da29981548464"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3784c5f4eeab56a8524da29981548464">&#9670;&nbsp;</a></span>~AuthContext()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual grpc::AuthContext::~AuthContext </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="add9dbb40b1a822f683a7ebad71e774f2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#add9dbb40b1a822f683a7ebad71e774f2">&#9670;&nbsp;</a></span>AddProperty()</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::AuthContext::AddProperty </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;&#160;</td>
          <td class="paramname"><em>key</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classgrpc_1_1string__ref.html">grpc::string_ref</a> &amp;&#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>Mutation functions: should only be used by an <a class="el" href="classgrpc_1_1_auth_metadata_processor.html" title="Interface allowing custom server-side authorization based on credentials encoded in metadata...">AuthMetadataProcessor</a>. </p>

</div>
</div>
<a id="a4a4a9e18e05e1a06cf25b8a77edd8c89"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4a4a9e18e05e1a06cf25b8a77edd8c89">&#9670;&nbsp;</a></span>begin()</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_auth_property_iterator.html">AuthPropertyIterator</a> grpc::AuthContext::begin </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">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Iteration over all the properties. </p>

</div>
</div>
<a id="a81d358b427e0f1096e148918cdeef991"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a81d358b427e0f1096e148918cdeef991">&#9670;&nbsp;</a></span>end()</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_auth_property_iterator.html">AuthPropertyIterator</a> grpc::AuthContext::end </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">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual std::vector&lt;<a class="el" href="classgrpc_1_1string__ref.html">grpc::string_ref</a>&gt; grpc::AuthContext::FindPropertyValues </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;&#160;</td>
          <td class="paramname"><em>name</em></td><td>)</td>
          <td> const</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>Returns all the property values with the given name. </p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual std::vector&lt;<a class="el" href="classgrpc_1_1string__ref.html">grpc::string_ref</a>&gt; grpc::AuthContext::GetPeerIdentity </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">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>A peer identity. </p>
<p>It is, in general, comprised of one or more properties (in which case they have the same name). </p>

</div>
</div>
<a id="ad7b2e589590246b953decd05cdaa4465"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad7b2e589590246b953decd05cdaa4465">&#9670;&nbsp;</a></span>GetPeerIdentityPropertyName()</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="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> grpc::AuthContext::GetPeerIdentityPropertyName </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">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="af1d6a5c7cd67694d1a485c4127eb63dc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af1d6a5c7cd67694d1a485c4127eb63dc">&#9670;&nbsp;</a></span>IsPeerAuthenticated()</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::AuthContext::IsPeerAuthenticated </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">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Returns true if the peer is authenticated. </p>

</div>
</div>
<a id="a218158a0698137b9c5d6fff0c8054cc4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a218158a0698137b9c5d6fff0c8054cc4">&#9670;&nbsp;</a></span>SetPeerIdentityPropertyName()</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::AuthContext::SetPeerIdentityPropertyName </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;&#160;</td>
          <td class="paramname"><em>name</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">

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/grpcpp/impl/codegen/security/<a class="el" href="grpcpp_2impl_2codegen_2security_2auth__context_8h_source.html">auth_context.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue May 15 2018 17:01:01 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>