natas_hw
/
grpc
0
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
grpc/cpp/structgrpc_1_1_ssl_server_c...

232 lines
12 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GRPC C++: grpc::SslServerCredentialsOptions 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.22.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</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="structgrpc_1_1_ssl_server_credentials_options.html">SslServerCredentialsOptions</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> &#124;
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">grpc::SslServerCredentialsOptions Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Options to create ServerCredentials with SSL.
<a href="structgrpc_1_1_ssl_server_credentials_options.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="grpcpp_2security_2server__credentials_8h_source.html">server_credentials.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_1_ssl_server_credentials_options_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:ae85661f17b0dd9f4fc27275203e5f105"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc_1_1_ssl_server_credentials_options.html#ae85661f17b0dd9f4fc27275203e5f105">SslServerCredentialsOptions</a> ()</td></tr>
<tr class="separator:ae85661f17b0dd9f4fc27275203e5f105"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a00650afd8a132f271b068d17da446679"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc_1_1_ssl_server_credentials_options.html#a00650afd8a132f271b068d17da446679">SslServerCredentialsOptions</a> (<a class="el" href="grpc__security__constants_8h.html#a29ffe63a8bb3b4945ecab42d82758f09">grpc_ssl_client_certificate_request_type</a> request_type)</td></tr>
<tr class="separator:a00650afd8a132f271b068d17da446679"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:acdde73dba83ee30aeda4a678f5ce8e74"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc_1_1_ssl_server_credentials_options.html#acdde73dba83ee30aeda4a678f5ce8e74">pem_root_certs</a></td></tr>
<tr class="separator:acdde73dba83ee30aeda4a678f5ce8e74"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3a042e846edd3d1e2f24e846e36c694d"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="structgrpc_1_1_ssl_server_credentials_options_1_1_pem_key_cert_pair.html">PemKeyCertPair</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc_1_1_ssl_server_credentials_options.html#a3a042e846edd3d1e2f24e846e36c694d">pem_key_cert_pairs</a></td></tr>
<tr class="separator:a3a042e846edd3d1e2f24e846e36c694d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa563c0e5a34e389dbc2f4dfa3c097e3e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc_1_1_ssl_server_credentials_options.html#aa563c0e5a34e389dbc2f4dfa3c097e3e">force_client_auth</a></td></tr>
<tr class="separator:aa563c0e5a34e389dbc2f4dfa3c097e3e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a646486fd3adbacf5805ff013f5362f5c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="grpc__security__constants_8h.html#a29ffe63a8bb3b4945ecab42d82758f09">grpc_ssl_client_certificate_request_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc_1_1_ssl_server_credentials_options.html#a646486fd3adbacf5805ff013f5362f5c">client_certificate_request</a></td></tr>
<tr class="memdesc:a646486fd3adbacf5805ff013f5362f5c"><td class="mdescLeft">&#160;</td><td class="mdescRight">If both <em>force_client_auth</em> and <em>client_certificate_request</em> fields are set, <em>force_client_auth</em> takes effect, i.e. <a href="#a646486fd3adbacf5805ff013f5362f5c">More...</a><br /></td></tr>
<tr class="separator:a646486fd3adbacf5805ff013f5362f5c"><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>Options to create ServerCredentials with SSL. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ae85661f17b0dd9f4fc27275203e5f105"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae85661f17b0dd9f4fc27275203e5f105">&#9670;&nbsp;</a></span>SslServerCredentialsOptions() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">grpc::SslServerCredentialsOptions::SslServerCredentialsOptions </td>
<td>(</td>
<td class="paramname"></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">
<dl class="section warning"><dt>Warning</dt><dd>Deprecated </dd></dl>
</div>
</div>
<a id="a00650afd8a132f271b068d17da446679"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a00650afd8a132f271b068d17da446679">&#9670;&nbsp;</a></span>SslServerCredentialsOptions() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">grpc::SslServerCredentialsOptions::SslServerCredentialsOptions </td>
<td>(</td>
<td class="paramtype"><a class="el" href="grpc__security__constants_8h.html#a29ffe63a8bb3b4945ecab42d82758f09">grpc_ssl_client_certificate_request_type</a>&#160;</td>
<td class="paramname"><em>request_type</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>
<h2 class="groupheader">Field Documentation</h2>
<a id="a646486fd3adbacf5805ff013f5362f5c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a646486fd3adbacf5805ff013f5362f5c">&#9670;&nbsp;</a></span>client_certificate_request</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="grpc__security__constants_8h.html#a29ffe63a8bb3b4945ecab42d82758f09">grpc_ssl_client_certificate_request_type</a> grpc::SslServerCredentialsOptions::client_certificate_request</td>
</tr>
</table>
</div><div class="memdoc">
<p>If both <em>force_client_auth</em> and <em>client_certificate_request</em> fields are set, <em>force_client_auth</em> takes effect, i.e. </p>
<p><em>REQUEST_AND_REQUIRE_CLIENT_CERTIFICATE_AND_VERIFY</em> will be enforced. </p>
</div>
</div>
<a id="aa563c0e5a34e389dbc2f4dfa3c097e3e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa563c0e5a34e389dbc2f4dfa3c097e3e">&#9670;&nbsp;</a></span>force_client_auth</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool grpc::SslServerCredentialsOptions::force_client_auth</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section warning"><dt>Warning</dt><dd>Deprecated </dd></dl>
</div>
</div>
<a id="a3a042e846edd3d1e2f24e846e36c694d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3a042e846edd3d1e2f24e846e36c694d">&#9670;&nbsp;</a></span>pem_key_cert_pairs</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector&lt;<a class="el" href="structgrpc_1_1_ssl_server_credentials_options_1_1_pem_key_cert_pair.html">PemKeyCertPair</a>&gt; grpc::SslServerCredentialsOptions::pem_key_cert_pairs</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="acdde73dba83ee30aeda4a678f5ce8e74"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acdde73dba83ee30aeda4a678f5ce8e74">&#9670;&nbsp;</a></span>pem_root_certs</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> grpc::SslServerCredentialsOptions::pem_root_certs</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>include/grpcpp/security/<a class="el" href="grpcpp_2security_2server__credentials_8h_source.html">server_credentials.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Jul 3 2019 14:51:27 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink