classgrpc_1_1experimental_1_1_file_watcher_certificate_provider.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277
  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::FileWatcherCertificateProvider 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_file_watcher_certificate_provider.html">FileWatcherCertificateProvider</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::FileWatcherCertificateProvider Class Reference<span class="mlabels"><span class="mlabel">final</span></span></div> </div>
  71. </div><!--header-->
  72. <div class="contents">
  73. <p><code>#include &lt;<a class="el" href="tls__certificate__provider_8h_source.html">tls_certificate_provider.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:a796ef530e5ff982a060413684830ce31"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1experimental_1_1_file_watcher_certificate_provider.html#a796ef530e5ff982a060413684830ce31">FileWatcherCertificateProvider</a> (const std::string &amp;private_key_path, const std::string &amp;identity_certificate_path, const std::string &amp;root_cert_path, unsigned int refresh_interval_sec)</td></tr>
  78. <tr class="separator:a796ef530e5ff982a060413684830ce31"><td class="memSeparator" colspan="2">&#160;</td></tr>
  79. <tr class="memitem:ac7afc32d97f7459e79d7de3176387865"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1experimental_1_1_file_watcher_certificate_provider.html#ac7afc32d97f7459e79d7de3176387865">FileWatcherCertificateProvider</a> (const std::string &amp;private_key_path, const std::string &amp;identity_certificate_path, unsigned int refresh_interval_sec)</td></tr>
  80. <tr class="separator:ac7afc32d97f7459e79d7de3176387865"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:af3edde419c3b8aad5e4a6f286c4c0369"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1experimental_1_1_file_watcher_certificate_provider.html#af3edde419c3b8aad5e4a6f286c4c0369">FileWatcherCertificateProvider</a> (const std::string &amp;root_cert_path, unsigned int refresh_interval_sec)</td></tr>
  82. <tr class="separator:af3edde419c3b8aad5e4a6f286c4c0369"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="memitem:a74b0da79f08e7d99612784b284c4535f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1experimental_1_1_file_watcher_certificate_provider.html#a74b0da79f08e7d99612784b284c4535f">~FileWatcherCertificateProvider</a> () override</td></tr>
  84. <tr class="separator:a74b0da79f08e7d99612784b284c4535f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr class="memitem:a52c6245b084bc0a811177b28fc023d2a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="grpc__security_8h.html#ab7eb1d297905525b6c1f0508de55c028">grpc_tls_certificate_provider</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1experimental_1_1_file_watcher_certificate_provider.html#a52c6245b084bc0a811177b28fc023d2a">c_provider</a> () override</td></tr>
  86. <tr class="separator:a52c6245b084bc0a811177b28fc023d2a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="inherit_header pub_methods_classgrpc_1_1experimental_1_1_certificate_provider_interface"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgrpc_1_1experimental_1_1_certificate_provider_interface')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classgrpc_1_1experimental_1_1_certificate_provider_interface.html">grpc::experimental::CertificateProviderInterface</a></td></tr>
  88. <tr class="memitem:afe79d717cfed70937978dfd030da57fb inherit pub_methods_classgrpc_1_1experimental_1_1_certificate_provider_interface"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1experimental_1_1_certificate_provider_interface.html#afe79d717cfed70937978dfd030da57fb">~CertificateProviderInterface</a> ()=default</td></tr>
  89. <tr class="separator:afe79d717cfed70937978dfd030da57fb inherit pub_methods_classgrpc_1_1experimental_1_1_certificate_provider_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. </table>
  91. <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  92. <a id="a796ef530e5ff982a060413684830ce31"></a>
  93. <h2 class="memtitle"><span class="permalink"><a href="#a796ef530e5ff982a060413684830ce31">&#9670;&nbsp;</a></span>FileWatcherCertificateProvider() <span class="overload">[1/3]</span></h2>
  94. <div class="memitem">
  95. <div class="memproto">
  96. <table class="memname">
  97. <tr>
  98. <td class="memname">grpc::experimental::FileWatcherCertificateProvider::FileWatcherCertificateProvider </td>
  99. <td>(</td>
  100. <td class="paramtype">const std::string &amp;&#160;</td>
  101. <td class="paramname"><em>private_key_path</em>, </td>
  102. </tr>
  103. <tr>
  104. <td class="paramkey"></td>
  105. <td></td>
  106. <td class="paramtype">const std::string &amp;&#160;</td>
  107. <td class="paramname"><em>identity_certificate_path</em>, </td>
  108. </tr>
  109. <tr>
  110. <td class="paramkey"></td>
  111. <td></td>
  112. <td class="paramtype">const std::string &amp;&#160;</td>
  113. <td class="paramname"><em>root_cert_path</em>, </td>
  114. </tr>
  115. <tr>
  116. <td class="paramkey"></td>
  117. <td></td>
  118. <td class="paramtype">unsigned int&#160;</td>
  119. <td class="paramname"><em>refresh_interval_sec</em>&#160;</td>
  120. </tr>
  121. <tr>
  122. <td></td>
  123. <td>)</td>
  124. <td></td><td></td>
  125. </tr>
  126. </table>
  127. </div><div class="memdoc">
  128. </div>
  129. </div>
  130. <a id="ac7afc32d97f7459e79d7de3176387865"></a>
  131. <h2 class="memtitle"><span class="permalink"><a href="#ac7afc32d97f7459e79d7de3176387865">&#9670;&nbsp;</a></span>FileWatcherCertificateProvider() <span class="overload">[2/3]</span></h2>
  132. <div class="memitem">
  133. <div class="memproto">
  134. <table class="mlabels">
  135. <tr>
  136. <td class="mlabels-left">
  137. <table class="memname">
  138. <tr>
  139. <td class="memname">grpc::experimental::FileWatcherCertificateProvider::FileWatcherCertificateProvider </td>
  140. <td>(</td>
  141. <td class="paramtype">const std::string &amp;&#160;</td>
  142. <td class="paramname"><em>private_key_path</em>, </td>
  143. </tr>
  144. <tr>
  145. <td class="paramkey"></td>
  146. <td></td>
  147. <td class="paramtype">const std::string &amp;&#160;</td>
  148. <td class="paramname"><em>identity_certificate_path</em>, </td>
  149. </tr>
  150. <tr>
  151. <td class="paramkey"></td>
  152. <td></td>
  153. <td class="paramtype">unsigned int&#160;</td>
  154. <td class="paramname"><em>refresh_interval_sec</em>&#160;</td>
  155. </tr>
  156. <tr>
  157. <td></td>
  158. <td>)</td>
  159. <td></td><td></td>
  160. </tr>
  161. </table>
  162. </td>
  163. <td class="mlabels-right">
  164. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  165. </tr>
  166. </table>
  167. </div><div class="memdoc">
  168. </div>
  169. </div>
  170. <a id="af3edde419c3b8aad5e4a6f286c4c0369"></a>
  171. <h2 class="memtitle"><span class="permalink"><a href="#af3edde419c3b8aad5e4a6f286c4c0369">&#9670;&nbsp;</a></span>FileWatcherCertificateProvider() <span class="overload">[3/3]</span></h2>
  172. <div class="memitem">
  173. <div class="memproto">
  174. <table class="mlabels">
  175. <tr>
  176. <td class="mlabels-left">
  177. <table class="memname">
  178. <tr>
  179. <td class="memname">grpc::experimental::FileWatcherCertificateProvider::FileWatcherCertificateProvider </td>
  180. <td>(</td>
  181. <td class="paramtype">const std::string &amp;&#160;</td>
  182. <td class="paramname"><em>root_cert_path</em>, </td>
  183. </tr>
  184. <tr>
  185. <td class="paramkey"></td>
  186. <td></td>
  187. <td class="paramtype">unsigned int&#160;</td>
  188. <td class="paramname"><em>refresh_interval_sec</em>&#160;</td>
  189. </tr>
  190. <tr>
  191. <td></td>
  192. <td>)</td>
  193. <td></td><td></td>
  194. </tr>
  195. </table>
  196. </td>
  197. <td class="mlabels-right">
  198. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  199. </tr>
  200. </table>
  201. </div><div class="memdoc">
  202. </div>
  203. </div>
  204. <a id="a74b0da79f08e7d99612784b284c4535f"></a>
  205. <h2 class="memtitle"><span class="permalink"><a href="#a74b0da79f08e7d99612784b284c4535f">&#9670;&nbsp;</a></span>~FileWatcherCertificateProvider()</h2>
  206. <div class="memitem">
  207. <div class="memproto">
  208. <table class="mlabels">
  209. <tr>
  210. <td class="mlabels-left">
  211. <table class="memname">
  212. <tr>
  213. <td class="memname">grpc::experimental::FileWatcherCertificateProvider::~FileWatcherCertificateProvider </td>
  214. <td>(</td>
  215. <td class="paramname"></td><td>)</td>
  216. <td></td>
  217. </tr>
  218. </table>
  219. </td>
  220. <td class="mlabels-right">
  221. <span class="mlabels"><span class="mlabel">override</span></span> </td>
  222. </tr>
  223. </table>
  224. </div><div class="memdoc">
  225. </div>
  226. </div>
  227. <h2 class="groupheader">Member Function Documentation</h2>
  228. <a id="a52c6245b084bc0a811177b28fc023d2a"></a>
  229. <h2 class="memtitle"><span class="permalink"><a href="#a52c6245b084bc0a811177b28fc023d2a">&#9670;&nbsp;</a></span>c_provider()</h2>
  230. <div class="memitem">
  231. <div class="memproto">
  232. <table class="mlabels">
  233. <tr>
  234. <td class="mlabels-left">
  235. <table class="memname">
  236. <tr>
  237. <td class="memname"><a class="el" href="grpc__security_8h.html#ab7eb1d297905525b6c1f0508de55c028">grpc_tls_certificate_provider</a>* grpc::experimental::FileWatcherCertificateProvider::c_provider </td>
  238. <td>(</td>
  239. <td class="paramname"></td><td>)</td>
  240. <td></td>
  241. </tr>
  242. </table>
  243. </td>
  244. <td class="mlabels-right">
  245. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  246. </tr>
  247. </table>
  248. </div><div class="memdoc">
  249. <p>Implements <a class="el" href="classgrpc_1_1experimental_1_1_certificate_provider_interface.html#a3f293b3dedea1935a82e3a3bb779e949">grpc::experimental::CertificateProviderInterface</a>.</p>
  250. </div>
  251. </div>
  252. <hr/>The documentation for this class was generated from the following file:<ul>
  253. <li>include/grpcpp/security/<a class="el" href="tls__certificate__provider_8h_source.html">tls_certificate_provider.h</a></li>
  254. </ul>
  255. </div><!-- contents -->
  256. <!-- start footer part -->
  257. <hr class="footer"/><address class="footer"><small>
  258. Generated on Wed Mar 3 2021 19:17:25 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  259. <img class="footer" src="doxygen.png" alt="doxygen"/>
  260. </a> 1.8.17
  261. </small></address>
  262. </body>
  263. </html>