classgrpc_1_1_metadata_credentials_plugin.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240
  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.11"/>
  7. <title>GRPC C++: grpc::MetadataCredentialsPlugin 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/searchdata.js"></script>
  13. <script type="text/javascript" src="search/search.js"></script>
  14. <script type="text/javascript">
  15. $(document).ready(function() { init_search(); });
  16. </script>
  17. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  18. </head>
  19. <body>
  20. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  21. <div id="titlearea">
  22. <table cellspacing="0" cellpadding="0">
  23. <tbody>
  24. <tr style="height: 56px;">
  25. <td id="projectalign" style="padding-left: 0.5em;">
  26. <div id="projectname">GRPC C++
  27. &#160;<span id="projectnumber">1.0.0</span>
  28. </div>
  29. </td>
  30. </tr>
  31. </tbody>
  32. </table>
  33. </div>
  34. <!-- end header part -->
  35. <!-- Generated by Doxygen 1.8.11 -->
  36. <script type="text/javascript">
  37. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  38. </script>
  39. <div id="navrow1" class="tabs">
  40. <ul class="tablist">
  41. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  42. <li><a href="modules.html"><span>Modules</span></a></li>
  43. <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  44. <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  45. <li><a href="files.html"><span>Files</span></a></li>
  46. <li>
  47. <div id="MSearchBox" class="MSearchBoxInactive">
  48. <span class="left">
  49. <img id="MSearchSelect" src="search/mag_sel.png"
  50. onmouseover="return searchBox.OnSearchSelectShow()"
  51. onmouseout="return searchBox.OnSearchSelectHide()"
  52. alt=""/>
  53. <input type="text" id="MSearchField" value="Search" accesskey="S"
  54. onfocus="searchBox.OnSearchFieldFocus(true)"
  55. onblur="searchBox.OnSearchFieldFocus(false)"
  56. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  57. </span><span class="right">
  58. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  59. </span>
  60. </div>
  61. </li>
  62. </ul>
  63. </div>
  64. <div id="navrow2" class="tabs2">
  65. <ul class="tablist">
  66. <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  67. <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
  68. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  69. <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
  70. </ul>
  71. </div>
  72. <!-- window showing the filter options -->
  73. <div id="MSearchSelectWindow"
  74. onmouseover="return searchBox.OnSearchSelectShow()"
  75. onmouseout="return searchBox.OnSearchSelectHide()"
  76. onkeydown="return searchBox.OnSearchSelectKey(event)">
  77. </div>
  78. <!-- iframe showing the search results (closed by default) -->
  79. <div id="MSearchResultsWindow">
  80. <iframe src="javascript:void(0)" frameborder="0"
  81. name="MSearchResults" id="MSearchResults">
  82. </iframe>
  83. </div>
  84. <div id="nav-path" class="navpath">
  85. <ul>
  86. <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>
  87. </div>
  88. </div><!-- top -->
  89. <div class="header">
  90. <div class="summary">
  91. <a href="#pub-methods">Public Member Functions</a> </div>
  92. <div class="headertitle">
  93. <div class="title">grpc::MetadataCredentialsPlugin Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
  94. </div><!--header-->
  95. <div class="contents">
  96. <p><code>#include &lt;<a class="el" href="credentials_8h_source.html">credentials.h</a>&gt;</code></p>
  97. <table class="memberdecls">
  98. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  99. Public Member Functions</h2></td></tr>
  100. <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>
  101. <tr class="separator:aa0f8c6fc458bf81c3d3384e84ad7059e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:ab3515201a954de40b0784647c057a95c"><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#ab3515201a954de40b0784647c057a95c">IsBlocking</a> () const </td></tr>
  103. <tr class="separator:ab3515201a954de40b0784647c057a95c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:a3b3a43e2ad1343ce57aa677c010ba7f3"><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#a3b3a43e2ad1343ce57aa677c010ba7f3">GetType</a> () const </td></tr>
  105. <tr class="separator:a3b3a43e2ad1343ce57aa677c010ba7f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:af39ac20596099995ddb1a80462ac2f0a"><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_metadata_credentials_plugin.html#af39ac20596099995ddb1a80462ac2f0a">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">AuthContext</a> &amp;channel_auth_context, std::multimap&lt; <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a>, <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &gt; *metadata)=0</td></tr>
  107. <tr class="separator:af39ac20596099995ddb1a80462ac2f0a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. </table>
  109. <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  110. <a class="anchor" id="aa0f8c6fc458bf81c3d3384e84ad7059e"></a>
  111. <div class="memitem">
  112. <div class="memproto">
  113. <table class="mlabels">
  114. <tr>
  115. <td class="mlabels-left">
  116. <table class="memname">
  117. <tr>
  118. <td class="memname">virtual grpc::MetadataCredentialsPlugin::~MetadataCredentialsPlugin </td>
  119. <td>(</td>
  120. <td class="paramname"></td><td>)</td>
  121. <td></td>
  122. </tr>
  123. </table>
  124. </td>
  125. <td class="mlabels-right">
  126. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
  127. </tr>
  128. </table>
  129. </div><div class="memdoc">
  130. </div>
  131. </div>
  132. <h2 class="groupheader">Member Function Documentation</h2>
  133. <a class="anchor" id="af39ac20596099995ddb1a80462ac2f0a"></a>
  134. <div class="memitem">
  135. <div class="memproto">
  136. <table class="mlabels">
  137. <tr>
  138. <td class="mlabels-left">
  139. <table class="memname">
  140. <tr>
  141. <td class="memname">virtual <a class="el" href="classgrpc_1_1_status.html">Status</a> grpc::MetadataCredentialsPlugin::GetMetadata </td>
  142. <td>(</td>
  143. <td class="paramtype"><a class="el" href="classgrpc_1_1string__ref.html">grpc::string_ref</a>&#160;</td>
  144. <td class="paramname"><em>service_url</em>, </td>
  145. </tr>
  146. <tr>
  147. <td class="paramkey"></td>
  148. <td></td>
  149. <td class="paramtype"><a class="el" href="classgrpc_1_1string__ref.html">grpc::string_ref</a>&#160;</td>
  150. <td class="paramname"><em>method_name</em>, </td>
  151. </tr>
  152. <tr>
  153. <td class="paramkey"></td>
  154. <td></td>
  155. <td class="paramtype">const <a class="el" href="classgrpc_1_1_auth_context.html">AuthContext</a> &amp;&#160;</td>
  156. <td class="paramname"><em>channel_auth_context</em>, </td>
  157. </tr>
  158. <tr>
  159. <td class="paramkey"></td>
  160. <td></td>
  161. <td class="paramtype">std::multimap&lt; <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a>, <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &gt; *&#160;</td>
  162. <td class="paramname"><em>metadata</em>&#160;</td>
  163. </tr>
  164. <tr>
  165. <td></td>
  166. <td>)</td>
  167. <td></td><td></td>
  168. </tr>
  169. </table>
  170. </td>
  171. <td class="mlabels-right">
  172. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  173. </tr>
  174. </table>
  175. </div><div class="memdoc">
  176. </div>
  177. </div>
  178. <a class="anchor" id="a3b3a43e2ad1343ce57aa677c010ba7f3"></a>
  179. <div class="memitem">
  180. <div class="memproto">
  181. <table class="mlabels">
  182. <tr>
  183. <td class="mlabels-left">
  184. <table class="memname">
  185. <tr>
  186. <td class="memname">virtual const char* grpc::MetadataCredentialsPlugin::GetType </td>
  187. <td>(</td>
  188. <td class="paramname"></td><td>)</td>
  189. <td> const</td>
  190. </tr>
  191. </table>
  192. </td>
  193. <td class="mlabels-right">
  194. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
  195. </tr>
  196. </table>
  197. </div><div class="memdoc">
  198. </div>
  199. </div>
  200. <a class="anchor" id="ab3515201a954de40b0784647c057a95c"></a>
  201. <div class="memitem">
  202. <div class="memproto">
  203. <table class="mlabels">
  204. <tr>
  205. <td class="mlabels-left">
  206. <table class="memname">
  207. <tr>
  208. <td class="memname">virtual bool grpc::MetadataCredentialsPlugin::IsBlocking </td>
  209. <td>(</td>
  210. <td class="paramname"></td><td>)</td>
  211. <td> const</td>
  212. </tr>
  213. </table>
  214. </td>
  215. <td class="mlabels-right">
  216. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
  217. </tr>
  218. </table>
  219. </div><div class="memdoc">
  220. </div>
  221. </div>
  222. <hr/>The documentation for this class was generated from the following file:<ul>
  223. <li>include/grpc++/security/<a class="el" href="credentials_8h_source.html">credentials.h</a></li>
  224. </ul>
  225. </div><!-- contents -->
  226. <!-- start footer part -->
  227. <hr class="footer"/><address class="footer"><small>
  228. Generated on Thu Aug 18 2016 21:34:58 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  229. <img class="footer" src="doxygen.png" alt="doxygen"/>
  230. </a> 1.8.11
  231. </small></address>
  232. </body>
  233. </html>