classgrpc__impl_1_1experimental_1_1_tls_credentials_options.html 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332
  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.16"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>GRPC C++: grpc_impl::experimental::TlsCredentialsOptions 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.28.0</span>
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.8.16 -->
  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__impl.html">grpc_impl</a></li><li class="navelem"><a class="el" href="namespacegrpc__impl_1_1experimental.html">experimental</a></li><li class="navelem"><a class="el" href="classgrpc__impl_1_1experimental_1_1_tls_credentials_options.html">TlsCredentialsOptions</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> </div>
  69. <div class="headertitle">
  70. <div class="title">grpc_impl::experimental::TlsCredentialsOptions Class Reference</div> </div>
  71. </div><!--header-->
  72. <div class="contents">
  73. <p>TLS credentials options, wrapper for grpc_tls_credentials_options.
  74. <a href="classgrpc__impl_1_1experimental_1_1_tls_credentials_options.html#details">More...</a></p>
  75. <p><code>#include &lt;<a class="el" href="tls__credentials__options_8h_source.html">tls_credentials_options.h</a>&gt;</code></p>
  76. <table class="memberdecls">
  77. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  78. Public Member Functions</h2></td></tr>
  79. <tr class="memitem:acddbd93bfd677175afbc34832777602f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1experimental_1_1_tls_credentials_options.html#acddbd93bfd677175afbc34832777602f">TlsCredentialsOptions</a> (<a class="el" href="grpc__security__constants_8h.html#a29ffe63a8bb3b4945ecab42d82758f09">grpc_ssl_client_certificate_request_type</a> <a class="el" href="classgrpc__impl_1_1experimental_1_1_tls_credentials_options.html#ad795a7d5217931f8937fcbd9aa38c6ff">cert_request_type</a>, <a class="el" href="grpc__security__constants_8h.html#aa4b37b544134e070541912584793446a">grpc_tls_server_verification_option</a> <a class="el" href="classgrpc__impl_1_1experimental_1_1_tls_credentials_options.html#aa9ab0b44498e871a4fd13999a922ebf1">server_verification_option</a>, std::shared_ptr&lt; <a class="el" href="classgrpc__impl_1_1experimental_1_1_tls_key_materials_config.html">TlsKeyMaterialsConfig</a> &gt; <a class="el" href="classgrpc__impl_1_1experimental_1_1_tls_credentials_options.html#a81ce7fbbeb5c13a6658e21aec58f2b14">key_materials_config</a>, std::shared_ptr&lt; <a class="el" href="classgrpc__impl_1_1experimental_1_1_tls_credential_reload_config.html">TlsCredentialReloadConfig</a> &gt; <a class="el" href="classgrpc__impl_1_1experimental_1_1_tls_credentials_options.html#a897564b915e54ee6681267aa8e88324c">credential_reload_config</a>, std::shared_ptr&lt; <a class="el" href="classgrpc__impl_1_1experimental_1_1_tls_server_authorization_check_config.html">TlsServerAuthorizationCheckConfig</a> &gt; <a class="el" href="classgrpc__impl_1_1experimental_1_1_tls_credentials_options.html#a92e2e52e4c3d30bb42a1e3b4d16d04a6">server_authorization_check_config</a>)</td></tr>
  80. <tr class="separator:acddbd93bfd677175afbc34832777602f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:a51550ce7c395ae8f9dd504262c0a0857"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1experimental_1_1_tls_credentials_options.html#a51550ce7c395ae8f9dd504262c0a0857">~TlsCredentialsOptions</a> ()</td></tr>
  82. <tr class="separator:a51550ce7c395ae8f9dd504262c0a0857"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="memitem:ad795a7d5217931f8937fcbd9aa38c6ff"><td class="memItemLeft" align="right" valign="top"><a class="el" href="grpc__security__constants_8h.html#a29ffe63a8bb3b4945ecab42d82758f09">grpc_ssl_client_certificate_request_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1experimental_1_1_tls_credentials_options.html#ad795a7d5217931f8937fcbd9aa38c6ff">cert_request_type</a> () const</td></tr>
  84. <tr class="memdesc:ad795a7d5217931f8937fcbd9aa38c6ff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Getters for member fields. <a href="classgrpc__impl_1_1experimental_1_1_tls_credentials_options.html#ad795a7d5217931f8937fcbd9aa38c6ff">More...</a><br /></td></tr>
  85. <tr class="separator:ad795a7d5217931f8937fcbd9aa38c6ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="memitem:aa9ab0b44498e871a4fd13999a922ebf1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="grpc__security__constants_8h.html#aa4b37b544134e070541912584793446a">grpc_tls_server_verification_option</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1experimental_1_1_tls_credentials_options.html#aa9ab0b44498e871a4fd13999a922ebf1">server_verification_option</a> () const</td></tr>
  87. <tr class="separator:aa9ab0b44498e871a4fd13999a922ebf1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:a81ce7fbbeb5c13a6658e21aec58f2b14"><td class="memItemLeft" align="right" valign="top">std::shared_ptr&lt; <a class="el" href="classgrpc__impl_1_1experimental_1_1_tls_key_materials_config.html">TlsKeyMaterialsConfig</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1experimental_1_1_tls_credentials_options.html#a81ce7fbbeb5c13a6658e21aec58f2b14">key_materials_config</a> () const</td></tr>
  89. <tr class="separator:a81ce7fbbeb5c13a6658e21aec58f2b14"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:a897564b915e54ee6681267aa8e88324c"><td class="memItemLeft" align="right" valign="top">std::shared_ptr&lt; <a class="el" href="classgrpc__impl_1_1experimental_1_1_tls_credential_reload_config.html">TlsCredentialReloadConfig</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1experimental_1_1_tls_credentials_options.html#a897564b915e54ee6681267aa8e88324c">credential_reload_config</a> () const</td></tr>
  91. <tr class="separator:a897564b915e54ee6681267aa8e88324c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:a92e2e52e4c3d30bb42a1e3b4d16d04a6"><td class="memItemLeft" align="right" valign="top">std::shared_ptr&lt; <a class="el" href="classgrpc__impl_1_1experimental_1_1_tls_server_authorization_check_config.html">TlsServerAuthorizationCheckConfig</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1experimental_1_1_tls_credentials_options.html#a92e2e52e4c3d30bb42a1e3b4d16d04a6">server_authorization_check_config</a> () const</td></tr>
  93. <tr class="separator:a92e2e52e4c3d30bb42a1e3b4d16d04a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:a6e9ee5ee2ffd231f97ee16462c73f4bd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="tls__credentials__options_8h.html#a8fe8a5a9b93ff8671a7843add47d57be">grpc_tls_credentials_options</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1experimental_1_1_tls_credentials_options.html#a6e9ee5ee2ffd231f97ee16462c73f4bd">c_credentials_options</a> () const</td></tr>
  95. <tr class="separator:a6e9ee5ee2ffd231f97ee16462c73f4bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. </table>
  97. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  98. <div class="textblock"><p>TLS credentials options, wrapper for grpc_tls_credentials_options. </p>
  99. <p>It is used for experimental purposes for now and it is subject to change. See the description of the grpc_tls_credentials_options struct in grpc_security.h for more details. </p>
  100. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  101. <a id="acddbd93bfd677175afbc34832777602f"></a>
  102. <h2 class="memtitle"><span class="permalink"><a href="#acddbd93bfd677175afbc34832777602f">&#9670;&nbsp;</a></span>TlsCredentialsOptions()</h2>
  103. <div class="memitem">
  104. <div class="memproto">
  105. <table class="memname">
  106. <tr>
  107. <td class="memname">grpc_impl::experimental::TlsCredentialsOptions::TlsCredentialsOptions </td>
  108. <td>(</td>
  109. <td class="paramtype"><a class="el" href="grpc__security__constants_8h.html#a29ffe63a8bb3b4945ecab42d82758f09">grpc_ssl_client_certificate_request_type</a>&#160;</td>
  110. <td class="paramname"><em>cert_request_type</em>, </td>
  111. </tr>
  112. <tr>
  113. <td class="paramkey"></td>
  114. <td></td>
  115. <td class="paramtype"><a class="el" href="grpc__security__constants_8h.html#aa4b37b544134e070541912584793446a">grpc_tls_server_verification_option</a>&#160;</td>
  116. <td class="paramname"><em>server_verification_option</em>, </td>
  117. </tr>
  118. <tr>
  119. <td class="paramkey"></td>
  120. <td></td>
  121. <td class="paramtype">std::shared_ptr&lt; <a class="el" href="classgrpc__impl_1_1experimental_1_1_tls_key_materials_config.html">TlsKeyMaterialsConfig</a> &gt;&#160;</td>
  122. <td class="paramname"><em>key_materials_config</em>, </td>
  123. </tr>
  124. <tr>
  125. <td class="paramkey"></td>
  126. <td></td>
  127. <td class="paramtype">std::shared_ptr&lt; <a class="el" href="classgrpc__impl_1_1experimental_1_1_tls_credential_reload_config.html">TlsCredentialReloadConfig</a> &gt;&#160;</td>
  128. <td class="paramname"><em>credential_reload_config</em>, </td>
  129. </tr>
  130. <tr>
  131. <td class="paramkey"></td>
  132. <td></td>
  133. <td class="paramtype">std::shared_ptr&lt; <a class="el" href="classgrpc__impl_1_1experimental_1_1_tls_server_authorization_check_config.html">TlsServerAuthorizationCheckConfig</a> &gt;&#160;</td>
  134. <td class="paramname"><em>server_authorization_check_config</em>&#160;</td>
  135. </tr>
  136. <tr>
  137. <td></td>
  138. <td>)</td>
  139. <td></td><td></td>
  140. </tr>
  141. </table>
  142. </div><div class="memdoc">
  143. </div>
  144. </div>
  145. <a id="a51550ce7c395ae8f9dd504262c0a0857"></a>
  146. <h2 class="memtitle"><span class="permalink"><a href="#a51550ce7c395ae8f9dd504262c0a0857">&#9670;&nbsp;</a></span>~TlsCredentialsOptions()</h2>
  147. <div class="memitem">
  148. <div class="memproto">
  149. <table class="memname">
  150. <tr>
  151. <td class="memname">grpc_impl::experimental::TlsCredentialsOptions::~TlsCredentialsOptions </td>
  152. <td>(</td>
  153. <td class="paramname"></td><td>)</td>
  154. <td></td>
  155. </tr>
  156. </table>
  157. </div><div class="memdoc">
  158. </div>
  159. </div>
  160. <h2 class="groupheader">Member Function Documentation</h2>
  161. <a id="a6e9ee5ee2ffd231f97ee16462c73f4bd"></a>
  162. <h2 class="memtitle"><span class="permalink"><a href="#a6e9ee5ee2ffd231f97ee16462c73f4bd">&#9670;&nbsp;</a></span>c_credentials_options()</h2>
  163. <div class="memitem">
  164. <div class="memproto">
  165. <table class="mlabels">
  166. <tr>
  167. <td class="mlabels-left">
  168. <table class="memname">
  169. <tr>
  170. <td class="memname"><a class="el" href="tls__credentials__options_8h.html#a8fe8a5a9b93ff8671a7843add47d57be">grpc_tls_credentials_options</a>* grpc_impl::experimental::TlsCredentialsOptions::c_credentials_options </td>
  171. <td>(</td>
  172. <td class="paramname"></td><td>)</td>
  173. <td> const</td>
  174. </tr>
  175. </table>
  176. </td>
  177. <td class="mlabels-right">
  178. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  179. </tr>
  180. </table>
  181. </div><div class="memdoc">
  182. </div>
  183. </div>
  184. <a id="ad795a7d5217931f8937fcbd9aa38c6ff"></a>
  185. <h2 class="memtitle"><span class="permalink"><a href="#ad795a7d5217931f8937fcbd9aa38c6ff">&#9670;&nbsp;</a></span>cert_request_type()</h2>
  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"><a class="el" href="grpc__security__constants_8h.html#a29ffe63a8bb3b4945ecab42d82758f09">grpc_ssl_client_certificate_request_type</a> grpc_impl::experimental::TlsCredentialsOptions::cert_request_type </td>
  194. <td>(</td>
  195. <td class="paramname"></td><td>)</td>
  196. <td> const</td>
  197. </tr>
  198. </table>
  199. </td>
  200. <td class="mlabels-right">
  201. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  202. </tr>
  203. </table>
  204. </div><div class="memdoc">
  205. <p>Getters for member fields. </p>
  206. </div>
  207. </div>
  208. <a id="a897564b915e54ee6681267aa8e88324c"></a>
  209. <h2 class="memtitle"><span class="permalink"><a href="#a897564b915e54ee6681267aa8e88324c">&#9670;&nbsp;</a></span>credential_reload_config()</h2>
  210. <div class="memitem">
  211. <div class="memproto">
  212. <table class="mlabels">
  213. <tr>
  214. <td class="mlabels-left">
  215. <table class="memname">
  216. <tr>
  217. <td class="memname">std::shared_ptr&lt;<a class="el" href="classgrpc__impl_1_1experimental_1_1_tls_credential_reload_config.html">TlsCredentialReloadConfig</a>&gt; grpc_impl::experimental::TlsCredentialsOptions::credential_reload_config </td>
  218. <td>(</td>
  219. <td class="paramname"></td><td>)</td>
  220. <td> const</td>
  221. </tr>
  222. </table>
  223. </td>
  224. <td class="mlabels-right">
  225. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  226. </tr>
  227. </table>
  228. </div><div class="memdoc">
  229. </div>
  230. </div>
  231. <a id="a81ce7fbbeb5c13a6658e21aec58f2b14"></a>
  232. <h2 class="memtitle"><span class="permalink"><a href="#a81ce7fbbeb5c13a6658e21aec58f2b14">&#9670;&nbsp;</a></span>key_materials_config()</h2>
  233. <div class="memitem">
  234. <div class="memproto">
  235. <table class="mlabels">
  236. <tr>
  237. <td class="mlabels-left">
  238. <table class="memname">
  239. <tr>
  240. <td class="memname">std::shared_ptr&lt;<a class="el" href="classgrpc__impl_1_1experimental_1_1_tls_key_materials_config.html">TlsKeyMaterialsConfig</a>&gt; grpc_impl::experimental::TlsCredentialsOptions::key_materials_config </td>
  241. <td>(</td>
  242. <td class="paramname"></td><td>)</td>
  243. <td> const</td>
  244. </tr>
  245. </table>
  246. </td>
  247. <td class="mlabels-right">
  248. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  249. </tr>
  250. </table>
  251. </div><div class="memdoc">
  252. </div>
  253. </div>
  254. <a id="a92e2e52e4c3d30bb42a1e3b4d16d04a6"></a>
  255. <h2 class="memtitle"><span class="permalink"><a href="#a92e2e52e4c3d30bb42a1e3b4d16d04a6">&#9670;&nbsp;</a></span>server_authorization_check_config()</h2>
  256. <div class="memitem">
  257. <div class="memproto">
  258. <table class="mlabels">
  259. <tr>
  260. <td class="mlabels-left">
  261. <table class="memname">
  262. <tr>
  263. <td class="memname">std::shared_ptr&lt;<a class="el" href="classgrpc__impl_1_1experimental_1_1_tls_server_authorization_check_config.html">TlsServerAuthorizationCheckConfig</a>&gt; grpc_impl::experimental::TlsCredentialsOptions::server_authorization_check_config </td>
  264. <td>(</td>
  265. <td class="paramname"></td><td>)</td>
  266. <td> const</td>
  267. </tr>
  268. </table>
  269. </td>
  270. <td class="mlabels-right">
  271. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  272. </tr>
  273. </table>
  274. </div><div class="memdoc">
  275. </div>
  276. </div>
  277. <a id="aa9ab0b44498e871a4fd13999a922ebf1"></a>
  278. <h2 class="memtitle"><span class="permalink"><a href="#aa9ab0b44498e871a4fd13999a922ebf1">&#9670;&nbsp;</a></span>server_verification_option()</h2>
  279. <div class="memitem">
  280. <div class="memproto">
  281. <table class="mlabels">
  282. <tr>
  283. <td class="mlabels-left">
  284. <table class="memname">
  285. <tr>
  286. <td class="memname"><a class="el" href="grpc__security__constants_8h.html#aa4b37b544134e070541912584793446a">grpc_tls_server_verification_option</a> grpc_impl::experimental::TlsCredentialsOptions::server_verification_option </td>
  287. <td>(</td>
  288. <td class="paramname"></td><td>)</td>
  289. <td> const</td>
  290. </tr>
  291. </table>
  292. </td>
  293. <td class="mlabels-right">
  294. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  295. </tr>
  296. </table>
  297. </div><div class="memdoc">
  298. </div>
  299. </div>
  300. <hr/>The documentation for this class was generated from the following file:<ul>
  301. <li>include/grpcpp/security/<a class="el" href="tls__credentials__options_8h_source.html">tls_credentials_options.h</a></li>
  302. </ul>
  303. </div><!-- contents -->
  304. <!-- start footer part -->
  305. <hr class="footer"/><address class="footer"><small>
  306. Generated on Tue Apr 7 2020 11:33:59 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  307. <img class="footer" src="doxygen.png" alt="doxygen"/>
  308. </a> 1.8.16
  309. </small></address>
  310. </body>
  311. </html>