classgrpc_1_1_auth_metadata_processor.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.6"/>
  7. <title>GRPC C++: grpc::AuthMetadataProcessor Class Reference</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  12. <script type="text/javascript" src="search/search.js"></script>
  13. <script type="text/javascript">
  14. $(document).ready(function() { searchBox.OnSelectItem(0); });
  15. </script>
  16. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  17. </head>
  18. <body>
  19. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  20. <div id="titlearea">
  21. <table cellspacing="0" cellpadding="0">
  22. <tbody>
  23. <tr style="height: 56px;">
  24. <td style="padding-left: 0.5em;">
  25. <div id="projectname">GRPC C++
  26. &#160;<span id="projectnumber">0.11.0.0</span>
  27. </div>
  28. </td>
  29. </tr>
  30. </tbody>
  31. </table>
  32. </div>
  33. <!-- end header part -->
  34. <!-- Generated by Doxygen 1.8.6 -->
  35. <script type="text/javascript">
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. </script>
  38. <div id="navrow1" class="tabs">
  39. <ul class="tablist">
  40. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  41. <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  42. <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  43. <li><a href="files.html"><span>Files</span></a></li>
  44. <li>
  45. <div id="MSearchBox" class="MSearchBoxInactive">
  46. <span class="left">
  47. <img id="MSearchSelect" src="search/mag_sel.png"
  48. onmouseover="return searchBox.OnSearchSelectShow()"
  49. onmouseout="return searchBox.OnSearchSelectHide()"
  50. alt=""/>
  51. <input type="text" id="MSearchField" value="Search" accesskey="S"
  52. onfocus="searchBox.OnSearchFieldFocus(true)"
  53. onblur="searchBox.OnSearchFieldFocus(false)"
  54. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  55. </span><span class="right">
  56. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  57. </span>
  58. </div>
  59. </li>
  60. </ul>
  61. </div>
  62. <div id="navrow2" class="tabs2">
  63. <ul class="tablist">
  64. <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  65. <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
  66. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  67. <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
  68. </ul>
  69. </div>
  70. <!-- window showing the filter options -->
  71. <div id="MSearchSelectWindow"
  72. onmouseover="return searchBox.OnSearchSelectShow()"
  73. onmouseout="return searchBox.OnSearchSelectHide()"
  74. onkeydown="return searchBox.OnSearchSelectKey(event)">
  75. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark">&#160;</span>Pages</a></div>
  76. <!-- iframe showing the search results (closed by default) -->
  77. <div id="MSearchResultsWindow">
  78. <iframe src="javascript:void(0)" frameborder="0"
  79. name="MSearchResults" id="MSearchResults">
  80. </iframe>
  81. </div>
  82. <div id="nav-path" class="navpath">
  83. <ul>
  84. <li class="navelem"><a class="el" href="namespacegrpc.html">grpc</a></li><li class="navelem"><a class="el" href="classgrpc_1_1_auth_metadata_processor.html">AuthMetadataProcessor</a></li> </ul>
  85. </div>
  86. </div><!-- top -->
  87. <div class="header">
  88. <div class="summary">
  89. <a href="#pub-types">Public Types</a> &#124;
  90. <a href="#pub-methods">Public Member Functions</a> </div>
  91. <div class="headertitle">
  92. <div class="title">grpc::AuthMetadataProcessor Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
  93. </div><!--header-->
  94. <div class="contents">
  95. <p><code>#include &lt;<a class="el" href="auth__metadata__processor_8h_source.html">auth_metadata_processor.h</a>&gt;</code></p>
  96. <table class="memberdecls">
  97. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
  98. Public Types</h2></td></tr>
  99. <tr class="memitem:a0c5846f57c862880f0f6db29577bb9e5"><td class="memItemLeft" align="right" valign="top">typedef std::multimap<br class="typebreak"/>
  100. &lt; <a class="el" href="classgrpc_1_1string__ref.html">grpc::string_ref</a>, <br class="typebreak"/>
  101. <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_metadata_processor.html#a0c5846f57c862880f0f6db29577bb9e5">InputMetadata</a></td></tr>
  102. <tr class="separator:a0c5846f57c862880f0f6db29577bb9e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:a809ec4913c189b392be05338acebb69a"><td class="memItemLeft" align="right" valign="top">typedef std::multimap<br class="typebreak"/>
  104. &lt; <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a>, <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_auth_metadata_processor.html#a809ec4913c189b392be05338acebb69a">OutputMetadata</a></td></tr>
  105. <tr class="separator:a809ec4913c189b392be05338acebb69a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. </table><table class="memberdecls">
  107. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  108. Public Member Functions</h2></td></tr>
  109. <tr class="memitem:ae64e2159109378600eb17f613ec4bbeb"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_auth_metadata_processor.html#ae64e2159109378600eb17f613ec4bbeb">~AuthMetadataProcessor</a> ()</td></tr>
  110. <tr class="separator:ae64e2159109378600eb17f613ec4bbeb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:a6cfe6ac34d5a25f14a5528462077243c"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_auth_metadata_processor.html#a6cfe6ac34d5a25f14a5528462077243c">IsBlocking</a> () const </td></tr>
  112. <tr class="separator:a6cfe6ac34d5a25f14a5528462077243c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <tr class="memitem:adc0db66aa261c59bd29f81c53f466303"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classgrpc_1_1_status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_auth_metadata_processor.html#adc0db66aa261c59bd29f81c53f466303">Process</a> (const <a class="el" href="classgrpc_1_1_auth_metadata_processor.html#a0c5846f57c862880f0f6db29577bb9e5">InputMetadata</a> &amp;auth_metadata, <a class="el" href="classgrpc_1_1_auth_context.html">AuthContext</a> *context, <a class="el" href="classgrpc_1_1_auth_metadata_processor.html#a809ec4913c189b392be05338acebb69a">OutputMetadata</a> *consumed_auth_metadata, <a class="el" href="classgrpc_1_1_auth_metadata_processor.html#a809ec4913c189b392be05338acebb69a">OutputMetadata</a> *response_metadata)=0</td></tr>
  114. <tr class="separator:adc0db66aa261c59bd29f81c53f466303"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. </table>
  116. <h2 class="groupheader">Member Typedef Documentation</h2>
  117. <a class="anchor" id="a0c5846f57c862880f0f6db29577bb9e5"></a>
  118. <div class="memitem">
  119. <div class="memproto">
  120. <table class="memname">
  121. <tr>
  122. <td class="memname">typedef std::multimap&lt;<a class="el" href="classgrpc_1_1string__ref.html">grpc::string_ref</a>, <a class="el" href="classgrpc_1_1string__ref.html">grpc::string_ref</a>&gt; <a class="el" href="classgrpc_1_1_auth_metadata_processor.html#a0c5846f57c862880f0f6db29577bb9e5">grpc::AuthMetadataProcessor::InputMetadata</a></td>
  123. </tr>
  124. </table>
  125. </div><div class="memdoc">
  126. </div>
  127. </div>
  128. <a class="anchor" id="a809ec4913c189b392be05338acebb69a"></a>
  129. <div class="memitem">
  130. <div class="memproto">
  131. <table class="memname">
  132. <tr>
  133. <td class="memname">typedef std::multimap&lt;<a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a>, <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a>&gt; <a class="el" href="classgrpc_1_1_auth_metadata_processor.html#a809ec4913c189b392be05338acebb69a">grpc::AuthMetadataProcessor::OutputMetadata</a></td>
  134. </tr>
  135. </table>
  136. </div><div class="memdoc">
  137. </div>
  138. </div>
  139. <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  140. <a class="anchor" id="ae64e2159109378600eb17f613ec4bbeb"></a>
  141. <div class="memitem">
  142. <div class="memproto">
  143. <table class="mlabels">
  144. <tr>
  145. <td class="mlabels-left">
  146. <table class="memname">
  147. <tr>
  148. <td class="memname">virtual grpc::AuthMetadataProcessor::~AuthMetadataProcessor </td>
  149. <td>(</td>
  150. <td class="paramname"></td><td>)</td>
  151. <td></td>
  152. </tr>
  153. </table>
  154. </td>
  155. <td class="mlabels-right">
  156. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
  157. </tr>
  158. </table>
  159. </div><div class="memdoc">
  160. </div>
  161. </div>
  162. <h2 class="groupheader">Member Function Documentation</h2>
  163. <a class="anchor" id="a6cfe6ac34d5a25f14a5528462077243c"></a>
  164. <div class="memitem">
  165. <div class="memproto">
  166. <table class="mlabels">
  167. <tr>
  168. <td class="mlabels-left">
  169. <table class="memname">
  170. <tr>
  171. <td class="memname">virtual bool grpc::AuthMetadataProcessor::IsBlocking </td>
  172. <td>(</td>
  173. <td class="paramname"></td><td>)</td>
  174. <td> const</td>
  175. </tr>
  176. </table>
  177. </td>
  178. <td class="mlabels-right">
  179. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
  180. </tr>
  181. </table>
  182. </div><div class="memdoc">
  183. </div>
  184. </div>
  185. <a class="anchor" id="adc0db66aa261c59bd29f81c53f466303"></a>
  186. <div class="memitem">
  187. <div class="memproto">
  188. <table class="mlabels">
  189. <tr>
  190. <td class="mlabels-left">
  191. <table class="memname">
  192. <tr>
  193. <td class="memname">virtual <a class="el" href="classgrpc_1_1_status.html">Status</a> grpc::AuthMetadataProcessor::Process </td>
  194. <td>(</td>
  195. <td class="paramtype">const <a class="el" href="classgrpc_1_1_auth_metadata_processor.html#a0c5846f57c862880f0f6db29577bb9e5">InputMetadata</a> &amp;&#160;</td>
  196. <td class="paramname"><em>auth_metadata</em>, </td>
  197. </tr>
  198. <tr>
  199. <td class="paramkey"></td>
  200. <td></td>
  201. <td class="paramtype"><a class="el" href="classgrpc_1_1_auth_context.html">AuthContext</a> *&#160;</td>
  202. <td class="paramname"><em>context</em>, </td>
  203. </tr>
  204. <tr>
  205. <td class="paramkey"></td>
  206. <td></td>
  207. <td class="paramtype"><a class="el" href="classgrpc_1_1_auth_metadata_processor.html#a809ec4913c189b392be05338acebb69a">OutputMetadata</a> *&#160;</td>
  208. <td class="paramname"><em>consumed_auth_metadata</em>, </td>
  209. </tr>
  210. <tr>
  211. <td class="paramkey"></td>
  212. <td></td>
  213. <td class="paramtype"><a class="el" href="classgrpc_1_1_auth_metadata_processor.html#a809ec4913c189b392be05338acebb69a">OutputMetadata</a> *&#160;</td>
  214. <td class="paramname"><em>response_metadata</em>&#160;</td>
  215. </tr>
  216. <tr>
  217. <td></td>
  218. <td>)</td>
  219. <td></td><td></td>
  220. </tr>
  221. </table>
  222. </td>
  223. <td class="mlabels-right">
  224. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  225. </tr>
  226. </table>
  227. </div><div class="memdoc">
  228. </div>
  229. </div>
  230. <hr/>The documentation for this class was generated from the following file:<ul>
  231. <li>include/grpc++/security/<a class="el" href="auth__metadata__processor_8h_source.html">auth_metadata_processor.h</a></li>
  232. </ul>
  233. </div><!-- contents -->
  234. <!-- start footer part -->
  235. <hr class="footer"/><address class="footer"><small>
  236. Generated on Tue Oct 27 2015 21:07:30 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  237. <img class="footer" src="doxygen.png" alt="doxygen"/>
  238. </a> 1.8.6
  239. </small></address>
  240. </body>
  241. </html>