carto
/
grpc


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291
							<!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::experimental::TlsKeyMaterialsConfig Class 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 id="nav-path" class="navpath">
  <ul>
<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_key_materials_config.html">TlsKeyMaterialsConfig</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#pub-methods">Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">grpc::experimental::TlsKeyMaterialsConfig Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>TLS key materials config, wrapper for grpc_tls_key_materials_config.  
 <a href="classgrpc_1_1experimental_1_1_tls_key_materials_config.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="tls__credentials__options_8h_source.html">tls_credentials_options.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc_1_1experimental_1_1_tls_key_materials_config_1_1_pem_key_cert_pair.html">PemKeyCertPair</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a94a229ca24549a280604336e9cb477df"><td class="memItemLeft" align="right" valign="top">const std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1experimental_1_1_tls_key_materials_config.html#a94a229ca24549a280604336e9cb477df">pem_root_certs</a> () const</td></tr>
<tr class="memdesc:a94a229ca24549a280604336e9cb477df"><td class="mdescLeft">&#160;</td><td class="mdescRight">Getters for member fields.  <a href="classgrpc_1_1experimental_1_1_tls_key_materials_config.html#a94a229ca24549a280604336e9cb477df">More...</a><br /></td></tr>
<tr class="separator:a94a229ca24549a280604336e9cb477df"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5b6dbf0dd1955409ed4b3984ecaa1af8"><td class="memItemLeft" align="right" valign="top">const std::vector&lt; <a class="el" href="structgrpc_1_1experimental_1_1_tls_key_materials_config_1_1_pem_key_cert_pair.html">PemKeyCertPair</a> &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1experimental_1_1_tls_key_materials_config.html#a5b6dbf0dd1955409ed4b3984ecaa1af8">pem_key_cert_pair_list</a> () const</td></tr>
<tr class="separator:a5b6dbf0dd1955409ed4b3984ecaa1af8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae29bf5ff73863fb8237ab48cd56f0b99"><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_key_materials_config.html#ae29bf5ff73863fb8237ab48cd56f0b99">version</a> () const</td></tr>
<tr class="separator:ae29bf5ff73863fb8237ab48cd56f0b99"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a44a7f940bd566c3a2627a2dfe1049479"><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_key_materials_config.html#a44a7f940bd566c3a2627a2dfe1049479">set_pem_root_certs</a> (const std::string &amp;<a class="el" href="classgrpc_1_1experimental_1_1_tls_key_materials_config.html#a94a229ca24549a280604336e9cb477df">pem_root_certs</a>)</td></tr>
<tr class="memdesc:a44a7f940bd566c3a2627a2dfe1049479"><td class="mdescLeft">&#160;</td><td class="mdescRight">Setter for key materials that will be called by the user.  <a href="classgrpc_1_1experimental_1_1_tls_key_materials_config.html#a44a7f940bd566c3a2627a2dfe1049479">More...</a><br /></td></tr>
<tr class="separator:a44a7f940bd566c3a2627a2dfe1049479"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aea889ac8f193014d06ff1b9709912211"><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_key_materials_config.html#aea889ac8f193014d06ff1b9709912211">add_pem_key_cert_pair</a> (const <a class="el" href="structgrpc_1_1experimental_1_1_tls_key_materials_config_1_1_pem_key_cert_pair.html">PemKeyCertPair</a> &amp;pem_key_cert_pair)</td></tr>
<tr class="separator:aea889ac8f193014d06ff1b9709912211"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1f2e5ccb6ecd14a0fc8d5568feae7b71"><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_key_materials_config.html#a1f2e5ccb6ecd14a0fc8d5568feae7b71">set_key_materials</a> (const std::string &amp;<a class="el" href="classgrpc_1_1experimental_1_1_tls_key_materials_config.html#a94a229ca24549a280604336e9cb477df">pem_root_certs</a>, const std::vector&lt; <a class="el" href="structgrpc_1_1experimental_1_1_tls_key_materials_config_1_1_pem_key_cert_pair.html">PemKeyCertPair</a> &gt; &amp;<a class="el" href="classgrpc_1_1experimental_1_1_tls_key_materials_config.html#a5b6dbf0dd1955409ed4b3984ecaa1af8">pem_key_cert_pair_list</a>)</td></tr>
<tr class="separator:a1f2e5ccb6ecd14a0fc8d5568feae7b71"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a80bdef85a600f2e27ddb2734878a974d"><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_key_materials_config.html#a80bdef85a600f2e27ddb2734878a974d">set_version</a> (int <a class="el" href="classgrpc_1_1experimental_1_1_tls_key_materials_config.html#ae29bf5ff73863fb8237ab48cd56f0b99">version</a>)</td></tr>
<tr class="separator:a80bdef85a600f2e27ddb2734878a974d"><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>TLS key materials config, wrapper for grpc_tls_key_materials_config. </p>
<p>It is used for experimental purposes for now and subject to change. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="aea889ac8f193014d06ff1b9709912211"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aea889ac8f193014d06ff1b9709912211">&#9670;&nbsp;</a></span>add_pem_key_cert_pair()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void grpc::experimental::TlsKeyMaterialsConfig::add_pem_key_cert_pair </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structgrpc_1_1experimental_1_1_tls_key_materials_config_1_1_pem_key_cert_pair.html">PemKeyCertPair</a> &amp;&#160;</td>
          <td class="paramname"><em>pem_key_cert_pair</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="a5b6dbf0dd1955409ed4b3984ecaa1af8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5b6dbf0dd1955409ed4b3984ecaa1af8">&#9670;&nbsp;</a></span>pem_key_cert_pair_list()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const std::vector&lt;<a class="el" href="structgrpc_1_1experimental_1_1_tls_key_materials_config_1_1_pem_key_cert_pair.html">PemKeyCertPair</a>&gt;&amp; grpc::experimental::TlsKeyMaterialsConfig::pem_key_cert_pair_list </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="a94a229ca24549a280604336e9cb477df"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a94a229ca24549a280604336e9cb477df">&#9670;&nbsp;</a></span>pem_root_certs()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const std::string grpc::experimental::TlsKeyMaterialsConfig::pem_root_certs </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Getters for member fields. </p>

</div>
</div>
<a id="a1f2e5ccb6ecd14a0fc8d5568feae7b71"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1f2e5ccb6ecd14a0fc8d5568feae7b71">&#9670;&nbsp;</a></span>set_key_materials()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void grpc::experimental::TlsKeyMaterialsConfig::set_key_materials </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>pem_root_certs</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::vector&lt; <a class="el" href="structgrpc_1_1experimental_1_1_tls_key_materials_config_1_1_pem_key_cert_pair.html">PemKeyCertPair</a> &gt; &amp;&#160;</td>
          <td class="paramname"><em>pem_key_cert_pair_list</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="a44a7f940bd566c3a2627a2dfe1049479"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a44a7f940bd566c3a2627a2dfe1049479">&#9670;&nbsp;</a></span>set_pem_root_certs()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void grpc::experimental::TlsKeyMaterialsConfig::set_pem_root_certs </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>pem_root_certs</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Setter for key materials that will be called by the user. </p>
<p>Ownership of the arguments will not be transferred. </p>

</div>
</div>
<a id="a80bdef85a600f2e27ddb2734878a974d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a80bdef85a600f2e27ddb2734878a974d">&#9670;&nbsp;</a></span>set_version()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void grpc::experimental::TlsKeyMaterialsConfig::set_version </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>version</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="ae29bf5ff73863fb8237ab48cd56f0b99"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae29bf5ff73863fb8237ab48cd56f0b99">&#9670;&nbsp;</a></span>version()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">int grpc::experimental::TlsKeyMaterialsConfig::version </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/grpcpp/security/<a class="el" href="tls__credentials__options_8h_source.html">tls_credentials_options.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Sep 12 2020 00:53:57 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>