classgrpc_1_1_server_credentials.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>GRPC C++: grpc::ServerCredentials Class Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectalign" style="padding-left: 0.5em;">
  24. <div id="projectname">GRPC C++
  25. &#160;<span id="projectnumber">1.36.1</span>
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.8.17 -->
  34. <script type="text/javascript">
  35. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. /* @license-end */
  38. </script>
  39. <script type="text/javascript" src="menudata.js"></script>
  40. <script type="text/javascript" src="menu.js"></script>
  41. <script type="text/javascript">
  42. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  43. $(function() {
  44. initMenu('',true,false,'search.php','Search');
  45. $(document).ready(function() { init_search(); });
  46. });
  47. /* @license-end */</script>
  48. <div id="main-nav"></div>
  49. <!-- window showing the filter options -->
  50. <div id="MSearchSelectWindow"
  51. onmouseover="return searchBox.OnSearchSelectShow()"
  52. onmouseout="return searchBox.OnSearchSelectHide()"
  53. onkeydown="return searchBox.OnSearchSelectKey(event)">
  54. </div>
  55. <!-- iframe showing the search results (closed by default) -->
  56. <div id="MSearchResultsWindow">
  57. <iframe src="javascript:void(0)" frameborder="0"
  58. name="MSearchResults" id="MSearchResults">
  59. </iframe>
  60. </div>
  61. <div id="nav-path" class="navpath">
  62. <ul>
  63. <li class="navelem"><a class="el" href="namespacegrpc.html">grpc</a></li><li class="navelem"><a class="el" href="classgrpc_1_1_server_credentials.html">ServerCredentials</a></li> </ul>
  64. </div>
  65. </div><!-- top -->
  66. <div class="header">
  67. <div class="summary">
  68. <a href="#pub-methods">Public Member Functions</a> &#124;
  69. <a href="#friends">Friends</a> </div>
  70. <div class="headertitle">
  71. <div class="title">grpc::ServerCredentials Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
  72. </div><!--header-->
  73. <div class="contents">
  74. <p>Wrapper around <em>grpc_server_credentials</em>, a way to authenticate a server.
  75. <a href="classgrpc_1_1_server_credentials.html#details">More...</a></p>
  76. <p><code>#include &lt;<a class="el" href="grpcpp_2security_2server__credentials_8h_source.html">server_credentials.h</a>&gt;</code></p>
  77. <table class="memberdecls">
  78. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  79. Public Member Functions</h2></td></tr>
  80. <tr class="memitem:ae4271df98b9da8ac4fada0c147e1674a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_credentials.html#ae4271df98b9da8ac4fada0c147e1674a">ServerCredentials</a> ()</td></tr>
  81. <tr class="separator:ae4271df98b9da8ac4fada0c147e1674a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <tr class="memitem:a2b25359ccca36f025fc82327c5aad0f8"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_credentials.html#a2b25359ccca36f025fc82327c5aad0f8">~ServerCredentials</a> () override</td></tr>
  83. <tr class="separator:a2b25359ccca36f025fc82327c5aad0f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:aac2d5861ec4c0534c3eaa7b36f5cc6fa"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_credentials.html#aac2d5861ec4c0534c3eaa7b36f5cc6fa">SetAuthMetadataProcessor</a> (const std::shared_ptr&lt; <a class="el" href="classgrpc_1_1_auth_metadata_processor.html">grpc::AuthMetadataProcessor</a> &gt; &amp;processor)=0</td></tr>
  85. <tr class="memdesc:aac2d5861ec4c0534c3eaa7b36f5cc6fa"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method is not thread-safe and has to be called before the server is started. <a href="classgrpc_1_1_server_credentials.html#aac2d5861ec4c0534c3eaa7b36f5cc6fa">More...</a><br /></td></tr>
  86. <tr class="separator:aac2d5861ec4c0534c3eaa7b36f5cc6fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. </table><table class="memberdecls">
  88. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
  89. Friends</h2></td></tr>
  90. <tr class="memitem:ac2055578ac48afabe5af487878450f68"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_credentials.html#ac2055578ac48afabe5af487878450f68">Server</a></td></tr>
  91. <tr class="separator:ac2055578ac48afabe5af487878450f68"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:a0f39d43c1609f7ea288d76ba4047fb5c"><td class="memItemLeft" align="right" valign="top">std::shared_ptr&lt; <a class="el" href="classgrpc_1_1_server_credentials.html">ServerCredentials</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_credentials.html#a0f39d43c1609f7ea288d76ba4047fb5c">grpc::experimental::XdsServerCredentials</a> (const std::shared_ptr&lt; <a class="el" href="classgrpc_1_1_server_credentials.html">ServerCredentials</a> &gt; &amp;fallback_credentials)</td></tr>
  93. <tr class="separator:a0f39d43c1609f7ea288d76ba4047fb5c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. </table>
  95. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  96. <div class="textblock"><p>Wrapper around <em>grpc_server_credentials</em>, a way to authenticate a server. </p>
  97. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  98. <a id="ae4271df98b9da8ac4fada0c147e1674a"></a>
  99. <h2 class="memtitle"><span class="permalink"><a href="#ae4271df98b9da8ac4fada0c147e1674a">&#9670;&nbsp;</a></span>ServerCredentials()</h2>
  100. <div class="memitem">
  101. <div class="memproto">
  102. <table class="memname">
  103. <tr>
  104. <td class="memname">grpc::ServerCredentials::ServerCredentials </td>
  105. <td>(</td>
  106. <td class="paramname"></td><td>)</td>
  107. <td></td>
  108. </tr>
  109. </table>
  110. </div><div class="memdoc">
  111. </div>
  112. </div>
  113. <a id="a2b25359ccca36f025fc82327c5aad0f8"></a>
  114. <h2 class="memtitle"><span class="permalink"><a href="#a2b25359ccca36f025fc82327c5aad0f8">&#9670;&nbsp;</a></span>~ServerCredentials()</h2>
  115. <div class="memitem">
  116. <div class="memproto">
  117. <table class="mlabels">
  118. <tr>
  119. <td class="mlabels-left">
  120. <table class="memname">
  121. <tr>
  122. <td class="memname">grpc::ServerCredentials::~ServerCredentials </td>
  123. <td>(</td>
  124. <td class="paramname"></td><td>)</td>
  125. <td></td>
  126. </tr>
  127. </table>
  128. </td>
  129. <td class="mlabels-right">
  130. <span class="mlabels"><span class="mlabel">override</span></span> </td>
  131. </tr>
  132. </table>
  133. </div><div class="memdoc">
  134. </div>
  135. </div>
  136. <h2 class="groupheader">Member Function Documentation</h2>
  137. <a id="aac2d5861ec4c0534c3eaa7b36f5cc6fa"></a>
  138. <h2 class="memtitle"><span class="permalink"><a href="#aac2d5861ec4c0534c3eaa7b36f5cc6fa">&#9670;&nbsp;</a></span>SetAuthMetadataProcessor()</h2>
  139. <div class="memitem">
  140. <div class="memproto">
  141. <table class="mlabels">
  142. <tr>
  143. <td class="mlabels-left">
  144. <table class="memname">
  145. <tr>
  146. <td class="memname">virtual void grpc::ServerCredentials::SetAuthMetadataProcessor </td>
  147. <td>(</td>
  148. <td class="paramtype">const std::shared_ptr&lt; <a class="el" href="classgrpc_1_1_auth_metadata_processor.html">grpc::AuthMetadataProcessor</a> &gt; &amp;&#160;</td>
  149. <td class="paramname"><em>processor</em></td><td>)</td>
  150. <td></td>
  151. </tr>
  152. </table>
  153. </td>
  154. <td class="mlabels-right">
  155. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  156. </tr>
  157. </table>
  158. </div><div class="memdoc">
  159. <p>This method is not thread-safe and has to be called before the server is started. </p>
  160. <p>The last call to this function wins. </p>
  161. </div>
  162. </div>
  163. <h2 class="groupheader">Friends And Related Function Documentation</h2>
  164. <a id="a0f39d43c1609f7ea288d76ba4047fb5c"></a>
  165. <h2 class="memtitle"><span class="permalink"><a href="#a0f39d43c1609f7ea288d76ba4047fb5c">&#9670;&nbsp;</a></span>grpc::experimental::XdsServerCredentials</h2>
  166. <div class="memitem">
  167. <div class="memproto">
  168. <table class="mlabels">
  169. <tr>
  170. <td class="mlabels-left">
  171. <table class="memname">
  172. <tr>
  173. <td class="memname">std::shared_ptr&lt;<a class="el" href="classgrpc_1_1_server_credentials.html">ServerCredentials</a>&gt; <a class="el" href="namespacegrpc_1_1experimental.html#a7317b5a2aba8ba9b1126d39609e7da58">grpc::experimental::XdsServerCredentials</a> </td>
  174. <td>(</td>
  175. <td class="paramtype">const std::shared_ptr&lt; <a class="el" href="classgrpc_1_1_server_credentials.html">ServerCredentials</a> &gt; &amp;&#160;</td>
  176. <td class="paramname"><em>fallback_credentials</em></td><td>)</td>
  177. <td></td>
  178. </tr>
  179. </table>
  180. </td>
  181. <td class="mlabels-right">
  182. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  183. </tr>
  184. </table>
  185. </div><div class="memdoc">
  186. </div>
  187. </div>
  188. <a id="ac2055578ac48afabe5af487878450f68"></a>
  189. <h2 class="memtitle"><span class="permalink"><a href="#ac2055578ac48afabe5af487878450f68">&#9670;&nbsp;</a></span>Server</h2>
  190. <div class="memitem">
  191. <div class="memproto">
  192. <table class="mlabels">
  193. <tr>
  194. <td class="mlabels-left">
  195. <table class="memname">
  196. <tr>
  197. <td class="memname">friend class <a class="el" href="classgrpc_1_1_server.html">Server</a></td>
  198. </tr>
  199. </table>
  200. </td>
  201. <td class="mlabels-right">
  202. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  203. </tr>
  204. </table>
  205. </div><div class="memdoc">
  206. </div>
  207. </div>
  208. <hr/>The documentation for this class was generated from the following file:<ul>
  209. <li>include/grpcpp/security/<a class="el" href="grpcpp_2security_2server__credentials_8h_source.html">server_credentials.h</a></li>
  210. </ul>
  211. </div><!-- contents -->
  212. <!-- start footer part -->
  213. <hr class="footer"/><address class="footer"><small>
  214. Generated on Wed Mar 3 2021 19:17:25 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  215. <img class="footer" src="doxygen.png" alt="doxygen"/>
  216. </a> 1.8.17
  217. </small></address>
  218. </body>
  219. </html>