blob: 0fb2ec326a89e13c41cb99096f94151e25604ade [file] [log] [blame]
<!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>Qpid Proton C++ API: ssl_server_options</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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</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>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</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">Qpid Proton C++ API
&#160;<span id="projectnumber">0.25.0</span>
</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</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>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classproton_1_1ssl__server__options.html','');});
</script>
<div id="doc-content">
<!-- 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 class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classproton_1_1ssl__server__options-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ssl_server_options</div> </div>
</div><!--header-->
<div class="contents">
<p><b>Unsettled API</b> - SSL configuration for inbound connections.
<a href="classproton_1_1ssl__server__options.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="ssl_8hpp_source.html">ssl.hpp</a>&gt;</code></p>
<p>Inherits ssl_domain.</p>
<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:a557e872dfb469537d374f04b969db547"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1ssl__server__options.html#a557e872dfb469537d374f04b969db547">ssl_server_options</a> (<a class="el" href="classproton_1_1ssl__certificate.html">ssl_certificate</a> &amp;cert)</td></tr>
<tr class="memdesc:a557e872dfb469537d374f04b969db547"><td class="mdescLeft">&#160;</td><td class="mdescRight">Server SSL options based on the supplied X.509 certificate specifier. <a href="#a557e872dfb469537d374f04b969db547">More...</a><br /></td></tr>
<tr class="separator:a557e872dfb469537d374f04b969db547"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abf0b30171760149fc5e8dacacbcd0b00"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1ssl__server__options.html#abf0b30171760149fc5e8dacacbcd0b00">ssl_server_options</a> (<a class="el" href="classproton_1_1ssl__certificate.html">ssl_certificate</a> &amp;cert, const std::string &amp;trust_db, const std::string &amp;advertise_db=std::string(), enum <a class="el" href="classproton_1_1ssl.html#abe68233596c90fd29d934854560ff5f3">ssl::verify_mode</a> mode=<a class="el" href="classproton_1_1ssl.html#abe68233596c90fd29d934854560ff5f3adb9333f2461b9f65dcb7346a8ceb185c">ssl::VERIFY_PEER</a>)</td></tr>
<tr class="memdesc:abf0b30171760149fc5e8dacacbcd0b00"><td class="mdescLeft">&#160;</td><td class="mdescRight">Server SSL options requiring connecting clients to provide a client certificate. <a href="#abf0b30171760149fc5e8dacacbcd0b00">More...</a><br /></td></tr>
<tr class="separator:abf0b30171760149fc5e8dacacbcd0b00"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1f181336edbdb677b58eaa1366127da1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1ssl__server__options.html#a1f181336edbdb677b58eaa1366127da1">ssl_server_options</a> ()</td></tr>
<tr class="memdesc:a1f181336edbdb677b58eaa1366127da1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Server SSL options restricted to available anonymous cipher suites on the platform. <a href="#a1f181336edbdb677b58eaa1366127da1">More...</a><br /></td></tr>
<tr class="separator:a1f181336edbdb677b58eaa1366127da1"><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><b>Unsettled API</b> - SSL configuration for inbound connections. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a557e872dfb469537d374f04b969db547"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a557e872dfb469537d374f04b969db547">&#9670;&nbsp;</a></span>ssl_server_options() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classproton_1_1ssl__server__options.html">ssl_server_options</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classproton_1_1ssl__certificate.html">ssl_certificate</a> &amp;&#160;</td>
<td class="paramname"><em>cert</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Server SSL options based on the supplied X.509 certificate specifier. </p>
</div>
</div>
<a id="abf0b30171760149fc5e8dacacbcd0b00"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abf0b30171760149fc5e8dacacbcd0b00">&#9670;&nbsp;</a></span>ssl_server_options() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classproton_1_1ssl__server__options.html">ssl_server_options</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classproton_1_1ssl__certificate.html">ssl_certificate</a> &amp;&#160;</td>
<td class="paramname"><em>cert</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>trust_db</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>advertise_db</em> = <code>std::string()</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">enum <a class="el" href="classproton_1_1ssl.html#abe68233596c90fd29d934854560ff5f3">ssl::verify_mode</a>&#160;</td>
<td class="paramname"><em>mode</em> = <code><a class="el" href="classproton_1_1ssl.html#abe68233596c90fd29d934854560ff5f3adb9333f2461b9f65dcb7346a8ceb185c">ssl::VERIFY_PEER</a></code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Server SSL options requiring connecting clients to provide a client certificate. </p>
</div>
</div>
<a id="a1f181336edbdb677b58eaa1366127da1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1f181336edbdb677b58eaa1366127da1">&#9670;&nbsp;</a></span>ssl_server_options() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classproton_1_1ssl__server__options.html">ssl_server_options</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Server SSL options restricted to available anonymous cipher suites on the platform. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>proton/<a class="el" href="ssl_8hpp_source.html">ssl.hpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespaceproton.html">proton</a></li><li class="navelem"><a class="el" href="classproton_1_1ssl__server__options.html">ssl_server_options</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>
</div>
</body>
</html>