carto
/
grpc


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GRPC C++: grpc_tls_credential_reload_arg Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">GRPC C++
   &#160;<span id="projectnumber">1.32.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">grpc_tls_credential_reload_arg Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>A struct containing all information necessary to schedule/cancel a credential reload request.  
 <a href="structgrpc__tls__credential__reload__arg.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="grpc__security_8h_source.html">grpc_security.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a334d8ef3177532d0a1e2094d4a23233c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="grpc__security_8h.html#a4c79c219cfe6c68ce52d2b195ec2ed0a">grpc_tls_on_credential_reload_done_cb</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__tls__credential__reload__arg.html#a334d8ef3177532d0a1e2094d4a23233c">cb</a></td></tr>
<tr class="separator:a334d8ef3177532d0a1e2094d4a23233c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a91a81a3317b88c3c380d7febad26b5e9"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__tls__credential__reload__arg.html#a91a81a3317b88c3c380d7febad26b5e9">cb_user_data</a></td></tr>
<tr class="separator:a91a81a3317b88c3c380d7febad26b5e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa28bad2203a56f05707535913ffdde98"><td class="memItemLeft" align="right" valign="top"><a class="el" href="grpc__security_8h.html#a2967916eed7d3f7aa1f8fbf3fc45d9ce">grpc_tls_key_materials_config</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__tls__credential__reload__arg.html#aa28bad2203a56f05707535913ffdde98">key_materials_config</a></td></tr>
<tr class="separator:aa28bad2203a56f05707535913ffdde98"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4d7f7be6bb3a174e289eafe75526ae9d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="grpc__security__constants_8h.html#a4f19e93998bbda68d9c24f27673ff627">grpc_ssl_certificate_config_reload_status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__tls__credential__reload__arg.html#a4d7f7be6bb3a174e289eafe75526ae9d">status</a></td></tr>
<tr class="separator:a4d7f7be6bb3a174e289eafe75526ae9d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a25442a1fa1cfdb5eb64ce41d295d67a2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="grpc__security_8h.html#aedcefc12b72d7ec5691ed39a0e9020c6">grpc_tls_error_details</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__tls__credential__reload__arg.html#a25442a1fa1cfdb5eb64ce41d295d67a2">error_details</a></td></tr>
<tr class="separator:a25442a1fa1cfdb5eb64ce41d295d67a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad704bf86341f423d1fc9f8fb7a9f95c4"><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="structgrpc__tls__credential__reload__arg.html#ad704bf86341f423d1fc9f8fb7a9f95c4">config</a></td></tr>
<tr class="separator:ad704bf86341f423d1fc9f8fb7a9f95c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a351c3904aa7154c947a724d7d5203115"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__tls__credential__reload__arg.html#a351c3904aa7154c947a724d7d5203115">context</a></td></tr>
<tr class="separator:a351c3904aa7154c947a724d7d5203115"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a26ffe67d208d353d24caa0135c9723f4"><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__tls__credential__reload__arg.html#a26ffe67d208d353d24caa0135c9723f4">destroy_context</a> )(void *ctx)</td></tr>
<tr class="separator:a26ffe67d208d353d24caa0135c9723f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A struct containing all information necessary to schedule/cancel a credential reload request. </p>
<ul>
<li>cb and cb_user_data represent a gRPC-provided callback and an argument passed to it.</li>
<li>key_materials_config is an in/output parameter containing currently used/newly reloaded credentials. If credential reload does not result in a new credential, key_materials_config should not be modified. The same key_materials_config object can be updated if new key materials is available.</li>
<li>status and error_details are used to hold information about errors occurred when a credential reload request is scheduled/cancelled.</li>
<li>config is a pointer to the unique grpc_tls_credential_reload_config instance that this argument corresponds to.</li>
<li>context is a pointer to a wrapped language implementation of this <a class="el" href="structgrpc__tls__credential__reload__arg.html" title="A struct containing all information necessary to schedule/cancel a credential reload request.">grpc_tls_credential_reload_arg</a> instance.</li>
<li>destroy_context is a pointer to a caller-provided method that cleans up any data associated with the context pointer. It is used for experimental purposes for now and subject to change. </li>
</ul>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="a334d8ef3177532d0a1e2094d4a23233c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a334d8ef3177532d0a1e2094d4a23233c">&#9670;&nbsp;</a></span>cb</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="grpc__security_8h.html#a4c79c219cfe6c68ce52d2b195ec2ed0a">grpc_tls_on_credential_reload_done_cb</a> grpc_tls_credential_reload_arg::cb</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="a91a81a3317b88c3c380d7febad26b5e9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a91a81a3317b88c3c380d7febad26b5e9">&#9670;&nbsp;</a></span>cb_user_data</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void* grpc_tls_credential_reload_arg::cb_user_data</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="ad704bf86341f423d1fc9f8fb7a9f95c4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad704bf86341f423d1fc9f8fb7a9f95c4">&#9670;&nbsp;</a></span>config</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="grpc__security_8h.html#aed7d78aacba36dda7c4e95668e1e8f8e">grpc_tls_credential_reload_config</a>* grpc_tls_credential_reload_arg::config</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="a351c3904aa7154c947a724d7d5203115"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a351c3904aa7154c947a724d7d5203115">&#9670;&nbsp;</a></span>context</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void* grpc_tls_credential_reload_arg::context</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="a26ffe67d208d353d24caa0135c9723f4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a26ffe67d208d353d24caa0135c9723f4">&#9670;&nbsp;</a></span>destroy_context</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void(* grpc_tls_credential_reload_arg::destroy_context) (void *ctx)</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="a25442a1fa1cfdb5eb64ce41d295d67a2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a25442a1fa1cfdb5eb64ce41d295d67a2">&#9670;&nbsp;</a></span>error_details</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="grpc__security_8h.html#aedcefc12b72d7ec5691ed39a0e9020c6">grpc_tls_error_details</a>* grpc_tls_credential_reload_arg::error_details</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="aa28bad2203a56f05707535913ffdde98"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa28bad2203a56f05707535913ffdde98">&#9670;&nbsp;</a></span>key_materials_config</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="grpc__security_8h.html#a2967916eed7d3f7aa1f8fbf3fc45d9ce">grpc_tls_key_materials_config</a>* grpc_tls_credential_reload_arg::key_materials_config</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="a4d7f7be6bb3a174e289eafe75526ae9d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4d7f7be6bb3a174e289eafe75526ae9d">&#9670;&nbsp;</a></span>status</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="grpc__security__constants_8h.html#a4f19e93998bbda68d9c24f27673ff627">grpc_ssl_certificate_config_reload_status</a> grpc_tls_credential_reload_arg::status</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>include/grpc/<a class="el" href="grpc__security_8h_source.html">grpc_security.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Sep 12 2020 00:53:56 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>