91 lines
15 KiB
HTML
91 lines
15 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++: include/grpcpp/security/auth_metadata_processor_impl.h Source File</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="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_412f9a3d5dfcba8716486cd870ef4586.html">grpcpp</a></li><li class="navelem"><a class="el" href="dir_121096a639b520446ccef04f840b5644.html">security</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">auth_metadata_processor_impl.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="auth__metadata__processor__impl_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> *</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Copyright 2015 gRPC authors.</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * Licensed under the Apache License, Version 2.0 (the "License");</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * you may not use this file except in compliance with the License.</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * You may obtain a copy of the License at</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> *</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> *</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * See the License for the specific language governing permissions and</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * limitations under the License.</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> *</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> */</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#ifndef GRPCPP_SECURITY_AUTH_METADATA_PROCESSOR_IMPL_H</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#define GRPCPP_SECURITY_AUTH_METADATA_PROCESSOR_IMPL_H</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include <map></span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <<a class="code" href="grpcpp_2security_2auth__context_8h.html">grpcpp/security/auth_context.h</a>></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <<a class="code" href="grpcpp_2support_2status_8h.html">grpcpp/support/status.h</a>></span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <<a class="code" href="grpcpp_2support_2string__ref_8h.html">grpcpp/support/string_ref.h</a>></span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">namespace </span><a class="code" href="namespacegrpc__impl.html">grpc_impl</a> {</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div><div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="classgrpc__impl_1_1_auth_metadata_processor.html"> 33</a></span> <span class="keyword">class </span><a class="code" href="classgrpc__impl_1_1_auth_metadata_processor.html">AuthMetadataProcessor</a> {</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="classgrpc__impl_1_1_auth_metadata_processor.html#a0572731cd7307cbb1d810ccb40e721a9"> 35</a></span>  <span class="keyword">typedef</span> std::multimap<grpc::string_ref, grpc::string_ref> <a class="code" href="classgrpc__impl_1_1_auth_metadata_processor.html#a0572731cd7307cbb1d810ccb40e721a9">InputMetadata</a>;</div><div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="classgrpc__impl_1_1_auth_metadata_processor.html#a3f878b87527db8d4963193fa2925d39e"> 36</a></span>  <span class="keyword">typedef</span> std::multimap<grpc::string, grpc::string> <a class="code" href="classgrpc__impl_1_1_auth_metadata_processor.html#a3f878b87527db8d4963193fa2925d39e">OutputMetadata</a>;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div><div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="classgrpc__impl_1_1_auth_metadata_processor.html#a364b1ab0360c4cd357e72f739d9b452c"> 38</a></span>  <span class="keyword">virtual</span> <a class="code" href="classgrpc__impl_1_1_auth_metadata_processor.html#a364b1ab0360c4cd357e72f739d9b452c">~AuthMetadataProcessor</a>() {}</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div><div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="classgrpc__impl_1_1_auth_metadata_processor.html#a4c4e7acec4575056c5527f3bad40233e"> 42</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classgrpc__impl_1_1_auth_metadata_processor.html#a4c4e7acec4575056c5527f3bad40233e">IsBlocking</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="keyword">true</span>; }</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keyword">virtual</span> <a class="code" href="classgrpc_1_1_status.html">grpc::Status</a> <a class="code" href="classgrpc__impl_1_1_auth_metadata_processor.html#a1e3e363531ad5062ee3a5b6fda9839f6">Process</a>(<span class="keyword">const</span> InputMetadata& auth_metadata,</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <a class="code" href="classgrpc_1_1_auth_context.html">grpc::AuthContext</a>* context,</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  OutputMetadata* consumed_auth_metadata,</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  OutputMetadata* response_metadata) = 0;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> };</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> } <span class="comment">// namespace grpc_impl</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="preprocessor">#endif // GRPCPP_SECURITY_AUTH_METADATA_PROCESSOR_IMPL_H</span></div><div class="ttc" id="grpcpp_2security_2auth__context_8h_html"><div class="ttname"><a href="grpcpp_2security_2auth__context_8h.html">auth_context.h</a></div></div>
|
|
<div class="ttc" id="grpcpp_2support_2string__ref_8h_html"><div class="ttname"><a href="grpcpp_2support_2string__ref_8h.html">string_ref.h</a></div></div>
|
|
<div class="ttc" id="classgrpc_1_1_auth_context_html"><div class="ttname"><a href="classgrpc_1_1_auth_context.html">grpc::AuthContext</a></div><div class="ttdoc">Class encapsulating the Authentication Information. </div><div class="ttdef"><b>Definition:</b> auth_context.h:65</div></div>
|
|
<div class="ttc" id="classgrpc__impl_1_1_auth_metadata_processor_html_a4c4e7acec4575056c5527f3bad40233e"><div class="ttname"><a href="classgrpc__impl_1_1_auth_metadata_processor.html#a4c4e7acec4575056c5527f3bad40233e">grpc_impl::AuthMetadataProcessor::IsBlocking</a></div><div class="ttdeci">virtual bool IsBlocking() const</div><div class="ttdoc">If this method returns true, the Process function will be scheduled in a different thread from the on...</div><div class="ttdef"><b>Definition:</b> auth_metadata_processor_impl.h:42</div></div>
|
|
<div class="ttc" id="classgrpc__impl_1_1_auth_metadata_processor_html"><div class="ttname"><a href="classgrpc__impl_1_1_auth_metadata_processor.html">grpc_impl::AuthMetadataProcessor</a></div><div class="ttdoc">Interface allowing custom server-side authorization based on credentials encoded in metadata...</div><div class="ttdef"><b>Definition:</b> auth_metadata_processor_impl.h:33</div></div>
|
|
<div class="ttc" id="grpcpp_2support_2status_8h_html"><div class="ttname"><a href="grpcpp_2support_2status_8h.html">status.h</a></div></div>
|
|
<div class="ttc" id="classgrpc__impl_1_1_auth_metadata_processor_html_a364b1ab0360c4cd357e72f739d9b452c"><div class="ttname"><a href="classgrpc__impl_1_1_auth_metadata_processor.html#a364b1ab0360c4cd357e72f739d9b452c">grpc_impl::AuthMetadataProcessor::~AuthMetadataProcessor</a></div><div class="ttdeci">virtual ~AuthMetadataProcessor()</div><div class="ttdef"><b>Definition:</b> auth_metadata_processor_impl.h:38</div></div>
|
|
<div class="ttc" id="classgrpc__impl_1_1_auth_metadata_processor_html_a3f878b87527db8d4963193fa2925d39e"><div class="ttname"><a href="classgrpc__impl_1_1_auth_metadata_processor.html#a3f878b87527db8d4963193fa2925d39e">grpc_impl::AuthMetadataProcessor::OutputMetadata</a></div><div class="ttdeci">std::multimap< grpc::string, grpc::string > OutputMetadata</div><div class="ttdef"><b>Definition:</b> auth_metadata_processor_impl.h:36</div></div>
|
|
<div class="ttc" id="namespacegrpc__impl_html"><div class="ttname"><a href="namespacegrpc__impl.html">grpc_impl</a></div><div class="ttdoc">An Alarm posts the user-provided tag to its associated completion queue or invokes the user-provided ...</div><div class="ttdef"><b>Definition:</b> alarm_impl.h:33</div></div>
|
|
<div class="ttc" id="classgrpc__impl_1_1_auth_metadata_processor_html_a1e3e363531ad5062ee3a5b6fda9839f6"><div class="ttname"><a href="classgrpc__impl_1_1_auth_metadata_processor.html#a1e3e363531ad5062ee3a5b6fda9839f6">grpc_impl::AuthMetadataProcessor::Process</a></div><div class="ttdeci">virtual grpc::Status Process(const InputMetadata &auth_metadata, grpc::AuthContext *context, OutputMetadata *consumed_auth_metadata, OutputMetadata *response_metadata)=0</div><div class="ttdoc">context is read/write: it contains the properties of the channel peer and it is the job of the Proces...</div></div>
|
|
<div class="ttc" id="classgrpc_1_1_status_html"><div class="ttname"><a href="classgrpc_1_1_status.html">grpc::Status</a></div><div class="ttdoc">Did it work? If it didn&#39;t, why? </div><div class="ttdef"><b>Definition:</b> status.h:31</div></div>
|
|
<div class="ttc" id="classgrpc__impl_1_1_auth_metadata_processor_html_a0572731cd7307cbb1d810ccb40e721a9"><div class="ttname"><a href="classgrpc__impl_1_1_auth_metadata_processor.html#a0572731cd7307cbb1d810ccb40e721a9">grpc_impl::AuthMetadataProcessor::InputMetadata</a></div><div class="ttdeci">std::multimap< grpc::string_ref, grpc::string_ref > InputMetadata</div><div class="ttdef"><b>Definition:</b> auth_metadata_processor_impl.h:35</div></div>
|
|
</div><!-- fragment --></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>
|