classgrpc_1_1experimental_1_1_tls_credentials_options.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238
  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::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.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="namespacegrpc_1_1experimental.html">experimental</a></li><li class="navelem"><a class="el" href="classgrpc_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::experimental::TlsCredentialsOptions Class Reference</div> </div>
  71. </div><!--header-->
  72. <div class="contents">
  73. <p><code>#include &lt;<a class="el" href="tls__credentials__options_8h_source.html">tls_credentials_options.h</a>&gt;</code></p>
  74. <table class="memberdecls">
  75. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  76. Public Member Functions</h2></td></tr>
  77. <tr class="memitem:ad5cb0c8ca0804ee26f274a7b2072bae9"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1experimental_1_1_tls_credentials_options.html#ad5cb0c8ca0804ee26f274a7b2072bae9">TlsCredentialsOptions</a> ()</td></tr>
  78. <tr class="separator:ad5cb0c8ca0804ee26f274a7b2072bae9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  79. <tr class="memitem:afd216d4f6b96c16d2e6708658b4fe0ce"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1experimental_1_1_tls_credentials_options.html#afd216d4f6b96c16d2e6708658b4fe0ce">set_certificate_provider</a> (std::shared_ptr&lt; <a class="el" href="classgrpc_1_1experimental_1_1_certificate_provider_interface.html">CertificateProviderInterface</a> &gt; certificate_provider)</td></tr>
  80. <tr class="separator:afd216d4f6b96c16d2e6708658b4fe0ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:a542db4c0dfdf4a8877086647bbf11bc5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1experimental_1_1_tls_credentials_options.html#a542db4c0dfdf4a8877086647bbf11bc5">watch_root_certs</a> ()</td></tr>
  82. <tr class="separator:a542db4c0dfdf4a8877086647bbf11bc5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="memitem:abe3c120f3b7df4c64fb0163a0024c37c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1experimental_1_1_tls_credentials_options.html#abe3c120f3b7df4c64fb0163a0024c37c">set_root_cert_name</a> (const std::string &amp;root_cert_name)</td></tr>
  84. <tr class="separator:abe3c120f3b7df4c64fb0163a0024c37c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr class="memitem:a6496e39d1b7e361653d6da9910c55292"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1experimental_1_1_tls_credentials_options.html#a6496e39d1b7e361653d6da9910c55292">watch_identity_key_cert_pairs</a> ()</td></tr>
  86. <tr class="separator:a6496e39d1b7e361653d6da9910c55292"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="memitem:aa2da2ef8f121fe50c0bae27b9907eb46"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1experimental_1_1_tls_credentials_options.html#aa2da2ef8f121fe50c0bae27b9907eb46">set_identity_cert_name</a> (const std::string &amp;identity_cert_name)</td></tr>
  88. <tr class="separator:aa2da2ef8f121fe50c0bae27b9907eb46"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <tr class="memitem:a3855df30b65ebe6a3b7d8ce23238943c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="grpc__security_8h.html#a8fe8a5a9b93ff8671a7843add47d57be">grpc_tls_credentials_options</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1experimental_1_1_tls_credentials_options.html#a3855df30b65ebe6a3b7d8ce23238943c">c_credentials_options</a> () const</td></tr>
  90. <tr class="separator:a3855df30b65ebe6a3b7d8ce23238943c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. </table>
  92. <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  93. <a id="ad5cb0c8ca0804ee26f274a7b2072bae9"></a>
  94. <h2 class="memtitle"><span class="permalink"><a href="#ad5cb0c8ca0804ee26f274a7b2072bae9">&#9670;&nbsp;</a></span>TlsCredentialsOptions()</h2>
  95. <div class="memitem">
  96. <div class="memproto">
  97. <table class="memname">
  98. <tr>
  99. <td class="memname">grpc::experimental::TlsCredentialsOptions::TlsCredentialsOptions </td>
  100. <td>(</td>
  101. <td class="paramname"></td><td>)</td>
  102. <td></td>
  103. </tr>
  104. </table>
  105. </div><div class="memdoc">
  106. </div>
  107. </div>
  108. <h2 class="groupheader">Member Function Documentation</h2>
  109. <a id="a3855df30b65ebe6a3b7d8ce23238943c"></a>
  110. <h2 class="memtitle"><span class="permalink"><a href="#a3855df30b65ebe6a3b7d8ce23238943c">&#9670;&nbsp;</a></span>c_credentials_options()</h2>
  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"><a class="el" href="grpc__security_8h.html#a8fe8a5a9b93ff8671a7843add47d57be">grpc_tls_credentials_options</a>* grpc::experimental::TlsCredentialsOptions::c_credentials_options </td>
  119. <td>(</td>
  120. <td class="paramname"></td><td>)</td>
  121. <td> const</td>
  122. </tr>
  123. </table>
  124. </td>
  125. <td class="mlabels-right">
  126. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  127. </tr>
  128. </table>
  129. </div><div class="memdoc">
  130. </div>
  131. </div>
  132. <a id="afd216d4f6b96c16d2e6708658b4fe0ce"></a>
  133. <h2 class="memtitle"><span class="permalink"><a href="#afd216d4f6b96c16d2e6708658b4fe0ce">&#9670;&nbsp;</a></span>set_certificate_provider()</h2>
  134. <div class="memitem">
  135. <div class="memproto">
  136. <table class="memname">
  137. <tr>
  138. <td class="memname">void grpc::experimental::TlsCredentialsOptions::set_certificate_provider </td>
  139. <td>(</td>
  140. <td class="paramtype">std::shared_ptr&lt; <a class="el" href="classgrpc_1_1experimental_1_1_certificate_provider_interface.html">CertificateProviderInterface</a> &gt;&#160;</td>
  141. <td class="paramname"><em>certificate_provider</em></td><td>)</td>
  142. <td></td>
  143. </tr>
  144. </table>
  145. </div><div class="memdoc">
  146. </div>
  147. </div>
  148. <a id="aa2da2ef8f121fe50c0bae27b9907eb46"></a>
  149. <h2 class="memtitle"><span class="permalink"><a href="#aa2da2ef8f121fe50c0bae27b9907eb46">&#9670;&nbsp;</a></span>set_identity_cert_name()</h2>
  150. <div class="memitem">
  151. <div class="memproto">
  152. <table class="memname">
  153. <tr>
  154. <td class="memname">void grpc::experimental::TlsCredentialsOptions::set_identity_cert_name </td>
  155. <td>(</td>
  156. <td class="paramtype">const std::string &amp;&#160;</td>
  157. <td class="paramname"><em>identity_cert_name</em></td><td>)</td>
  158. <td></td>
  159. </tr>
  160. </table>
  161. </div><div class="memdoc">
  162. </div>
  163. </div>
  164. <a id="abe3c120f3b7df4c64fb0163a0024c37c"></a>
  165. <h2 class="memtitle"><span class="permalink"><a href="#abe3c120f3b7df4c64fb0163a0024c37c">&#9670;&nbsp;</a></span>set_root_cert_name()</h2>
  166. <div class="memitem">
  167. <div class="memproto">
  168. <table class="memname">
  169. <tr>
  170. <td class="memname">void grpc::experimental::TlsCredentialsOptions::set_root_cert_name </td>
  171. <td>(</td>
  172. <td class="paramtype">const std::string &amp;&#160;</td>
  173. <td class="paramname"><em>root_cert_name</em></td><td>)</td>
  174. <td></td>
  175. </tr>
  176. </table>
  177. </div><div class="memdoc">
  178. </div>
  179. </div>
  180. <a id="a6496e39d1b7e361653d6da9910c55292"></a>
  181. <h2 class="memtitle"><span class="permalink"><a href="#a6496e39d1b7e361653d6da9910c55292">&#9670;&nbsp;</a></span>watch_identity_key_cert_pairs()</h2>
  182. <div class="memitem">
  183. <div class="memproto">
  184. <table class="memname">
  185. <tr>
  186. <td class="memname">void grpc::experimental::TlsCredentialsOptions::watch_identity_key_cert_pairs </td>
  187. <td>(</td>
  188. <td class="paramname"></td><td>)</td>
  189. <td></td>
  190. </tr>
  191. </table>
  192. </div><div class="memdoc">
  193. </div>
  194. </div>
  195. <a id="a542db4c0dfdf4a8877086647bbf11bc5"></a>
  196. <h2 class="memtitle"><span class="permalink"><a href="#a542db4c0dfdf4a8877086647bbf11bc5">&#9670;&nbsp;</a></span>watch_root_certs()</h2>
  197. <div class="memitem">
  198. <div class="memproto">
  199. <table class="memname">
  200. <tr>
  201. <td class="memname">void grpc::experimental::TlsCredentialsOptions::watch_root_certs </td>
  202. <td>(</td>
  203. <td class="paramname"></td><td>)</td>
  204. <td></td>
  205. </tr>
  206. </table>
  207. </div><div class="memdoc">
  208. </div>
  209. </div>
  210. <hr/>The documentation for this class was generated from the following file:<ul>
  211. <li>include/grpcpp/security/<a class="el" href="tls__credentials__options_8h_source.html">tls_credentials_options.h</a></li>
  212. </ul>
  213. </div><!-- contents -->
  214. <!-- start footer part -->
  215. <hr class="footer"/><address class="footer"><small>
  216. Generated on Wed Mar 3 2021 19:17:25 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  217. <img class="footer" src="doxygen.png" alt="doxygen"/>
  218. </a> 1.8.17
  219. </small></address>
  220. </body>
  221. </html>