classgrpc_1_1experimental_1_1_tls_credential_reload_config.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225
  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::TlsCredentialReloadConfig 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.32.0</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_credential_reload_config.html">TlsCredentialReloadConfig</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::TlsCredentialReloadConfig Class Reference</div> </div>
  71. </div><!--header-->
  72. <div class="contents">
  73. <p>TLS credential reloag config, wraps grpc_tls_credential_reload_config.
  74. <a href="classgrpc_1_1experimental_1_1_tls_credential_reload_config.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:a238f779ebd54652495816059cc24e49e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1experimental_1_1_tls_credential_reload_config.html#a238f779ebd54652495816059cc24e49e">TlsCredentialReloadConfig</a> (std::shared_ptr&lt; <a class="el" href="structgrpc_1_1experimental_1_1_tls_credential_reload_interface.html">TlsCredentialReloadInterface</a> &gt; credential_reload_interface)</td></tr>
  80. <tr class="separator:a238f779ebd54652495816059cc24e49e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:a67d21b51833c823355315e946935284b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1experimental_1_1_tls_credential_reload_config.html#a67d21b51833c823355315e946935284b">~TlsCredentialReloadConfig</a> ()</td></tr>
  82. <tr class="separator:a67d21b51833c823355315e946935284b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="memitem:a2accb259735c42dc8e029048872076c8"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1experimental_1_1_tls_credential_reload_config.html#a2accb259735c42dc8e029048872076c8">Schedule</a> (<a class="el" href="classgrpc_1_1experimental_1_1_tls_credential_reload_arg.html">TlsCredentialReloadArg</a> *arg) const</td></tr>
  84. <tr class="separator:a2accb259735c42dc8e029048872076c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr class="memitem:a2e4500e59d831b2ab23cf4e70a3d1d64"><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_credential_reload_config.html#a2e4500e59d831b2ab23cf4e70a3d1d64">Cancel</a> (<a class="el" href="classgrpc_1_1experimental_1_1_tls_credential_reload_arg.html">TlsCredentialReloadArg</a> *arg) const</td></tr>
  86. <tr class="separator:a2e4500e59d831b2ab23cf4e70a3d1d64"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="memitem:a71037ff1c16d8b2dd74154cd13936686"><td class="memItemLeft" align="right" valign="top"><a class="el" href="grpc__security_8h.html#aed7d78aacba36dda7c4e95668e1e8f8e">grpc_tls_credential_reload_config</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1experimental_1_1_tls_credential_reload_config.html#a71037ff1c16d8b2dd74154cd13936686">c_config</a> () const</td></tr>
  88. <tr class="memdesc:a71037ff1c16d8b2dd74154cd13936686"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a C struct for the credential reload config. <a href="classgrpc_1_1experimental_1_1_tls_credential_reload_config.html#a71037ff1c16d8b2dd74154cd13936686">More...</a><br /></td></tr>
  89. <tr class="separator:a71037ff1c16d8b2dd74154cd13936686"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. </table>
  91. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  92. <div class="textblock"><p>TLS credential reloag config, wraps grpc_tls_credential_reload_config. </p>
  93. <p>It is used for experimental purposes for now and it is subject to change. </p>
  94. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  95. <a id="a238f779ebd54652495816059cc24e49e"></a>
  96. <h2 class="memtitle"><span class="permalink"><a href="#a238f779ebd54652495816059cc24e49e">&#9670;&nbsp;</a></span>TlsCredentialReloadConfig()</h2>
  97. <div class="memitem">
  98. <div class="memproto">
  99. <table class="memname">
  100. <tr>
  101. <td class="memname">grpc::experimental::TlsCredentialReloadConfig::TlsCredentialReloadConfig </td>
  102. <td>(</td>
  103. <td class="paramtype">std::shared_ptr&lt; <a class="el" href="structgrpc_1_1experimental_1_1_tls_credential_reload_interface.html">TlsCredentialReloadInterface</a> &gt;&#160;</td>
  104. <td class="paramname"><em>credential_reload_interface</em></td><td>)</td>
  105. <td></td>
  106. </tr>
  107. </table>
  108. </div><div class="memdoc">
  109. </div>
  110. </div>
  111. <a id="a67d21b51833c823355315e946935284b"></a>
  112. <h2 class="memtitle"><span class="permalink"><a href="#a67d21b51833c823355315e946935284b">&#9670;&nbsp;</a></span>~TlsCredentialReloadConfig()</h2>
  113. <div class="memitem">
  114. <div class="memproto">
  115. <table class="memname">
  116. <tr>
  117. <td class="memname">grpc::experimental::TlsCredentialReloadConfig::~TlsCredentialReloadConfig </td>
  118. <td>(</td>
  119. <td class="paramname"></td><td>)</td>
  120. <td></td>
  121. </tr>
  122. </table>
  123. </div><div class="memdoc">
  124. </div>
  125. </div>
  126. <h2 class="groupheader">Member Function Documentation</h2>
  127. <a id="a71037ff1c16d8b2dd74154cd13936686"></a>
  128. <h2 class="memtitle"><span class="permalink"><a href="#a71037ff1c16d8b2dd74154cd13936686">&#9670;&nbsp;</a></span>c_config()</h2>
  129. <div class="memitem">
  130. <div class="memproto">
  131. <table class="mlabels">
  132. <tr>
  133. <td class="mlabels-left">
  134. <table class="memname">
  135. <tr>
  136. <td class="memname"><a class="el" href="grpc__security_8h.html#aed7d78aacba36dda7c4e95668e1e8f8e">grpc_tls_credential_reload_config</a>* grpc::experimental::TlsCredentialReloadConfig::c_config </td>
  137. <td>(</td>
  138. <td class="paramname"></td><td>)</td>
  139. <td> const</td>
  140. </tr>
  141. </table>
  142. </td>
  143. <td class="mlabels-right">
  144. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  145. </tr>
  146. </table>
  147. </div><div class="memdoc">
  148. <p>Returns a C struct for the credential reload config. </p>
  149. </div>
  150. </div>
  151. <a id="a2e4500e59d831b2ab23cf4e70a3d1d64"></a>
  152. <h2 class="memtitle"><span class="permalink"><a href="#a2e4500e59d831b2ab23cf4e70a3d1d64">&#9670;&nbsp;</a></span>Cancel()</h2>
  153. <div class="memitem">
  154. <div class="memproto">
  155. <table class="mlabels">
  156. <tr>
  157. <td class="mlabels-left">
  158. <table class="memname">
  159. <tr>
  160. <td class="memname">void grpc::experimental::TlsCredentialReloadConfig::Cancel </td>
  161. <td>(</td>
  162. <td class="paramtype"><a class="el" href="classgrpc_1_1experimental_1_1_tls_credential_reload_arg.html">TlsCredentialReloadArg</a> *&#160;</td>
  163. <td class="paramname"><em>arg</em></td><td>)</td>
  164. <td> const</td>
  165. </tr>
  166. </table>
  167. </td>
  168. <td class="mlabels-right">
  169. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  170. </tr>
  171. </table>
  172. </div><div class="memdoc">
  173. </div>
  174. </div>
  175. <a id="a2accb259735c42dc8e029048872076c8"></a>
  176. <h2 class="memtitle"><span class="permalink"><a href="#a2accb259735c42dc8e029048872076c8">&#9670;&nbsp;</a></span>Schedule()</h2>
  177. <div class="memitem">
  178. <div class="memproto">
  179. <table class="mlabels">
  180. <tr>
  181. <td class="mlabels-left">
  182. <table class="memname">
  183. <tr>
  184. <td class="memname">int grpc::experimental::TlsCredentialReloadConfig::Schedule </td>
  185. <td>(</td>
  186. <td class="paramtype"><a class="el" href="classgrpc_1_1experimental_1_1_tls_credential_reload_arg.html">TlsCredentialReloadArg</a> *&#160;</td>
  187. <td class="paramname"><em>arg</em></td><td>)</td>
  188. <td> const</td>
  189. </tr>
  190. </table>
  191. </td>
  192. <td class="mlabels-right">
  193. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  194. </tr>
  195. </table>
  196. </div><div class="memdoc">
  197. </div>
  198. </div>
  199. <hr/>The documentation for this class was generated from the following file:<ul>
  200. <li>include/grpcpp/security/<a class="el" href="tls__credentials__options_8h_source.html">tls_credentials_options.h</a></li>
  201. </ul>
  202. </div><!-- contents -->
  203. <!-- start footer part -->
  204. <hr class="footer"/><address class="footer"><small>
  205. Generated on Sat Sep 12 2020 00:53:57 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  206. <img class="footer" src="doxygen.png" alt="doxygen"/>
  207. </a> 1.8.17
  208. </small></address>
  209. </body>
  210. </html>