content/releases/qpid-proton-0.32.0/proton/cpp/api/classproton_1_1ssl.html - qpid-site - Git at Google

 <!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</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.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-types">Public Types</a> &#124;
 <a href="classproton_1_1ssl-members.html">List of all members</a>  </div>
   <div class="headertitle">
 <div class="title">ssl</div>  </div>
 </div><!--header-->
 <div class="contents">

 <p>SSL information.
  <a href="classproton_1_1ssl.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-types"></a>
 Public Types</h2></td></tr>
 <tr class="memitem:abe68233596c90fd29d934854560ff5f3"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1ssl.html#abe68233596c90fd29d934854560ff5f3">verify_mode</a> { <a class="el" href="classproton_1_1ssl.html#abe68233596c90fd29d934854560ff5f3adb9333f2461b9f65dcb7346a8ceb185c">VERIFY_PEER</a>,
 <a class="el" href="classproton_1_1ssl.html#abe68233596c90fd29d934854560ff5f3ac0c5cd6b794574267c2ad08f485bd76d">ANONYMOUS_PEER</a>,
 <a class="el" href="classproton_1_1ssl.html#abe68233596c90fd29d934854560ff5f3a57807a2e5ed5e9858db1e84f24e91a0a">VERIFY_PEER_NAME</a>
  }</td></tr>
 <tr class="memdesc:abe68233596c90fd29d934854560ff5f3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determines the level of peer validation.  <a href="classproton_1_1ssl.html#abe68233596c90fd29d934854560ff5f3">More...</a><br /></td></tr>
 <tr class="separator:abe68233596c90fd29d934854560ff5f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a0d3f14f27a1e5af0a5f378fc1a8a8de4"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1ssl.html#a0d3f14f27a1e5af0a5f378fc1a8a8de4">resume_status</a> { <a class="el" href="classproton_1_1ssl.html#a0d3f14f27a1e5af0a5f378fc1a8a8de4a6ce26a62afab55d7606ad4e92428b30c">UNKNOWN</a>,
 <a class="el" href="classproton_1_1ssl.html#a0d3f14f27a1e5af0a5f378fc1a8a8de4aec34b0b90541576a22697631105dc847">NEW</a>,
 <a class="el" href="classproton_1_1ssl.html#a0d3f14f27a1e5af0a5f378fc1a8a8de4a6a8b4831d126ce349ac966f2f469413f">REUSED</a>
  }</td></tr>
 <tr class="memdesc:a0d3f14f27a1e5af0a5f378fc1a8a8de4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Outcome specifier for an attempted session resume.  <a href="classproton_1_1ssl.html#a0d3f14f27a1e5af0a5f378fc1a8a8de4">More...</a><br /></td></tr>
 <tr class="separator:a0d3f14f27a1e5af0a5f378fc1a8a8de4"><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>SSL information. </p>
 </div><h2 class="groupheader">Member Enumeration Documentation</h2>
 <a id="abe68233596c90fd29d934854560ff5f3"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#abe68233596c90fd29d934854560ff5f3">&#9670;&nbsp;</a></span>verify_mode</h2>

 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname">enum <a class="el" href="classproton_1_1ssl.html#abe68233596c90fd29d934854560ff5f3">verify_mode</a></td>
         </tr>
       </table>
 </div><div class="memdoc">

 <p>Determines the level of peer validation. </p>
 <table class="fieldtable">
 <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="abe68233596c90fd29d934854560ff5f3adb9333f2461b9f65dcb7346a8ceb185c"></a>VERIFY_PEER&#160;</td><td class="fielddoc"><p>Require peer to provide a valid identifying certificate. </p>
 </td></tr>
 <tr><td class="fieldname"><a id="abe68233596c90fd29d934854560ff5f3ac0c5cd6b794574267c2ad08f485bd76d"></a>ANONYMOUS_PEER&#160;</td><td class="fielddoc"><p>Do not require a certificate or cipher authorization. </p>
 </td></tr>
 <tr><td class="fieldname"><a id="abe68233596c90fd29d934854560ff5f3a57807a2e5ed5e9858db1e84f24e91a0a"></a>VERIFY_PEER_NAME&#160;</td><td class="fielddoc"><p>Require valid certificate and matching name. </p>
 </td></tr>
 </table>

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

 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname">enum <a class="el" href="classproton_1_1ssl.html#a0d3f14f27a1e5af0a5f378fc1a8a8de4">resume_status</a></td>
         </tr>
       </table>
 </div><div class="memdoc">

 <p>Outcome specifier for an attempted session resume. </p>
 <table class="fieldtable">
 <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a0d3f14f27a1e5af0a5f378fc1a8a8de4a6ce26a62afab55d7606ad4e92428b30c"></a>UNKNOWN&#160;</td><td class="fielddoc"><p>Session resume state unknown or not supported. </p>
 </td></tr>
 <tr><td class="fieldname"><a id="a0d3f14f27a1e5af0a5f378fc1a8a8de4aec34b0b90541576a22697631105dc847"></a>NEW&#160;</td><td class="fielddoc"><p>Session renegotiated, not resumed. </p>
 </td></tr>
 <tr><td class="fieldname"><a id="a0d3f14f27a1e5af0a5f378fc1a8a8de4a6a8b4831d126ce349ac966f2f469413f"></a>REUSED&#160;</td><td class="fielddoc"><p>Session resumed from previous session. </p>
 </td></tr>
 </table>

 </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.html">ssl</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>
	<!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</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&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
	<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&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&dn=gpl-2.0.txt GPL-v2 */
	$(document).ready(function(){initNavTree('classproton_1_1ssl.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-types">Public Types</a> \|
	<a href="classproton_1_1ssl-members.html">List of all members</a> </div>
	<div class="headertitle">
	<div class="title">ssl</div> </div>
	</div><!--header-->
	<div class="contents">

	<p>SSL information.
	<a href="classproton_1_1ssl.html#details">More...</a></p>

	<p><code>#include <<a class="el" href="ssl_8hpp_source.html">ssl.hpp</a>></code></p>
	<table class="memberdecls">
	<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
	Public Types</h2></td></tr>
	<tr class="memitem:abe68233596c90fd29d934854560ff5f3"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1ssl.html#abe68233596c90fd29d934854560ff5f3">verify_mode</a> { <a class="el" href="classproton_1_1ssl.html#abe68233596c90fd29d934854560ff5f3adb9333f2461b9f65dcb7346a8ceb185c">VERIFY_PEER</a>,
	<a class="el" href="classproton_1_1ssl.html#abe68233596c90fd29d934854560ff5f3ac0c5cd6b794574267c2ad08f485bd76d">ANONYMOUS_PEER</a>,
	<a class="el" href="classproton_1_1ssl.html#abe68233596c90fd29d934854560ff5f3a57807a2e5ed5e9858db1e84f24e91a0a">VERIFY_PEER_NAME</a>
	}</td></tr>
	<tr class="memdesc:abe68233596c90fd29d934854560ff5f3"><td class="mdescLeft"> </td><td class="mdescRight">Determines the level of peer validation. <a href="classproton_1_1ssl.html#abe68233596c90fd29d934854560ff5f3">More...</a><br /></td></tr>
	<tr class="separator:abe68233596c90fd29d934854560ff5f3"><td class="memSeparator" colspan="2"> </td></tr>
	<tr class="memitem:a0d3f14f27a1e5af0a5f378fc1a8a8de4"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1ssl.html#a0d3f14f27a1e5af0a5f378fc1a8a8de4">resume_status</a> { <a class="el" href="classproton_1_1ssl.html#a0d3f14f27a1e5af0a5f378fc1a8a8de4a6ce26a62afab55d7606ad4e92428b30c">UNKNOWN</a>,
	<a class="el" href="classproton_1_1ssl.html#a0d3f14f27a1e5af0a5f378fc1a8a8de4aec34b0b90541576a22697631105dc847">NEW</a>,
	<a class="el" href="classproton_1_1ssl.html#a0d3f14f27a1e5af0a5f378fc1a8a8de4a6a8b4831d126ce349ac966f2f469413f">REUSED</a>
	}</td></tr>
	<tr class="memdesc:a0d3f14f27a1e5af0a5f378fc1a8a8de4"><td class="mdescLeft"> </td><td class="mdescRight">Outcome specifier for an attempted session resume. <a href="classproton_1_1ssl.html#a0d3f14f27a1e5af0a5f378fc1a8a8de4">More...</a><br /></td></tr>
	<tr class="separator:a0d3f14f27a1e5af0a5f378fc1a8a8de4"><td class="memSeparator" colspan="2"> </td></tr>
	</table>
	<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
	<div class="textblock"><p>SSL information. </p>
	</div><h2 class="groupheader">Member Enumeration Documentation</h2>
	<a id="abe68233596c90fd29d934854560ff5f3"></a>
	<h2 class="memtitle"><span class="permalink"><a href="#abe68233596c90fd29d934854560ff5f3">◆ </a></span>verify_mode</h2>

	<div class="memitem">
	<div class="memproto">
	<table class="memname">
	<tr>
	<td class="memname">enum <a class="el" href="classproton_1_1ssl.html#abe68233596c90fd29d934854560ff5f3">verify_mode</a></td>
	</tr>
	</table>
	</div><div class="memdoc">

	<p>Determines the level of peer validation. </p>
	<table class="fieldtable">
	<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="abe68233596c90fd29d934854560ff5f3adb9333f2461b9f65dcb7346a8ceb185c"></a>VERIFY_PEER </td><td class="fielddoc"><p>Require peer to provide a valid identifying certificate. </p>
	</td></tr>
	<tr><td class="fieldname"><a id="abe68233596c90fd29d934854560ff5f3ac0c5cd6b794574267c2ad08f485bd76d"></a>ANONYMOUS_PEER </td><td class="fielddoc"><p>Do not require a certificate or cipher authorization. </p>
	</td></tr>
	<tr><td class="fieldname"><a id="abe68233596c90fd29d934854560ff5f3a57807a2e5ed5e9858db1e84f24e91a0a"></a>VERIFY_PEER_NAME </td><td class="fielddoc"><p>Require valid certificate and matching name. </p>
	</td></tr>
	</table>

	</div>
	</div>
	<a id="a0d3f14f27a1e5af0a5f378fc1a8a8de4"></a>
	<h2 class="memtitle"><span class="permalink"><a href="#a0d3f14f27a1e5af0a5f378fc1a8a8de4">◆ </a></span>resume_status</h2>

	<div class="memitem">
	<div class="memproto">
	<table class="memname">
	<tr>
	<td class="memname">enum <a class="el" href="classproton_1_1ssl.html#a0d3f14f27a1e5af0a5f378fc1a8a8de4">resume_status</a></td>
	</tr>
	</table>
	</div><div class="memdoc">

	<p>Outcome specifier for an attempted session resume. </p>
	<table class="fieldtable">
	<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a0d3f14f27a1e5af0a5f378fc1a8a8de4a6ce26a62afab55d7606ad4e92428b30c"></a>UNKNOWN </td><td class="fielddoc"><p>Session resume state unknown or not supported. </p>
	</td></tr>
	<tr><td class="fieldname"><a id="a0d3f14f27a1e5af0a5f378fc1a8a8de4aec34b0b90541576a22697631105dc847"></a>NEW </td><td class="fielddoc"><p>Session renegotiated, not resumed. </p>
	</td></tr>
	<tr><td class="fieldname"><a id="a0d3f14f27a1e5af0a5f378fc1a8a8de4a6a8b4831d126ce349ac966f2f469413f"></a>REUSED </td><td class="fielddoc"><p>Session resumed from previous session. </p>
	</td></tr>
	</table>

	</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.html">ssl</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>