blob: 9597942814d84da4898b898106e05ac1899f313b [file] [log] [blame]
<!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.20"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Qpid Proton C++ API: ssl_client_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>
<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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function() { init_search(); });
/* @license-end */
</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.32.0</span>
</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.svg"
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.svg" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.20 -->
<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>
</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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classproton_1_1ssl__client__options.html',''); initResizable(); });
/* @license-end */
</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__client__options-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ssl_client_options</div> </div>
</div><!--header-->
<div class="contents">
<p><b>Unsettled API</b> - SSL configuration for outbound connections.
<a href="classproton_1_1ssl__client__options.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="ssl_8hpp_source.html">ssl.hpp</a>&gt;</code></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:a79e03058960606b2d656b57744d13284"><td class="memItemLeft" align="right" valign="top"><a id="a79e03058960606b2d656b57744d13284"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1ssl__client__options.html#a79e03058960606b2d656b57744d13284">ssl_client_options</a> ()</td></tr>
<tr class="memdesc:a79e03058960606b2d656b57744d13284"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create SSL client with defaults (use system certificate trust database and require name verification) <br /></td></tr>
<tr class="separator:a79e03058960606b2d656b57744d13284"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3367d63bb7bbba80909675836ce62625"><td class="memItemLeft" align="right" valign="top"><a id="a3367d63bb7bbba80909675836ce62625"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1ssl__client__options.html#a3367d63bb7bbba80909675836ce62625">ssl_client_options</a> (enum <a class="el" href="classproton_1_1ssl.html#abe68233596c90fd29d934854560ff5f3">ssl::verify_mode</a>)</td></tr>
<tr class="memdesc:a3367d63bb7bbba80909675836ce62625"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create SSL client with unusual verification policy (but default certificate trust database) <br /></td></tr>
<tr class="separator:a3367d63bb7bbba80909675836ce62625"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a05df3dc53e9dc80ed8d90b7724d791b0"><td class="memItemLeft" align="right" valign="top"><a id="a05df3dc53e9dc80ed8d90b7724d791b0"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1ssl__client__options.html#a05df3dc53e9dc80ed8d90b7724d791b0">ssl_client_options</a> (const std::string &amp;trust_db, enum <a class="el" href="classproton_1_1ssl.html#abe68233596c90fd29d934854560ff5f3">ssl::verify_mode</a>=<a class="el" href="classproton_1_1ssl.html#abe68233596c90fd29d934854560ff5f3a57807a2e5ed5e9858db1e84f24e91a0a">ssl::VERIFY_PEER_NAME</a>)</td></tr>
<tr class="memdesc:a05df3dc53e9dc80ed8d90b7724d791b0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create SSL client specifying the certificate trust database. <br /></td></tr>
<tr class="separator:a05df3dc53e9dc80ed8d90b7724d791b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a190dfbc28bfd776cbb619fd3398eff41"><td class="memItemLeft" align="right" valign="top"><a id="a190dfbc28bfd776cbb619fd3398eff41"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1ssl__client__options.html#a190dfbc28bfd776cbb619fd3398eff41">ssl_client_options</a> (const <a class="el" href="classproton_1_1ssl__certificate.html">ssl_certificate</a> &amp;, const std::string &amp;trust_db, enum <a class="el" href="classproton_1_1ssl.html#abe68233596c90fd29d934854560ff5f3">ssl::verify_mode</a>=<a class="el" href="classproton_1_1ssl.html#abe68233596c90fd29d934854560ff5f3a57807a2e5ed5e9858db1e84f24e91a0a">ssl::VERIFY_PEER_NAME</a>)</td></tr>
<tr class="memdesc:a190dfbc28bfd776cbb619fd3398eff41"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create SSL client with a client certificate. <br /></td></tr>
<tr class="separator:a190dfbc28bfd776cbb619fd3398eff41"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a79230544ab889bb1c0a31620a5fad3ab"><td class="memItemLeft" align="right" valign="top"><a id="a79230544ab889bb1c0a31620a5fad3ab"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>ssl_client_options</b> (const <a class="el" href="classproton_1_1ssl__client__options.html">ssl_client_options</a> &amp;)</td></tr>
<tr class="separator:a79230544ab889bb1c0a31620a5fad3ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a09b2095bdc0cc9d9f8854d6a80479b75"><td class="memItemLeft" align="right" valign="top"><a id="a09b2095bdc0cc9d9f8854d6a80479b75"></a>
<a class="el" href="classproton_1_1ssl__client__options.html">ssl_client_options</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classproton_1_1ssl__client__options.html">ssl_client_options</a> &amp;)</td></tr>
<tr class="separator:a09b2095bdc0cc9d9f8854d6a80479b75"><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 outbound connections. </p>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="service_bus_8cpp-example.html#_a4">service_bus.cpp</a>.</dd>
</dl>
</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__client__options.html">ssl_client_options</a></li>
<li class="footer">Generated by <a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20 </li>
</ul>
</div>
</body>
</html>