qpid-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jr...@apache.org
Subject [12/51] [partial] qpid-site git commit: QPID-7553: Update the proton api gen script for changes to the C api docs; republish the proton master doc snapshot
Date Fri, 02 Dec 2016 23:22:17 GMT
http://git-wip-us.apache.org/repos/asf/qpid-site/blob/cd4363b2/content/releases/qpid-proton-master/proton/c/api/group__ssl.html
----------------------------------------------------------------------
diff --git a/content/releases/qpid-proton-master/proton/c/api/group__ssl.html b/content/releases/qpid-proton-master/proton/c/api/group__ssl.html
index 8d127b7..d8f41be 100755
--- a/content/releases/qpid-proton-master/proton/c/api/group__ssl.html
+++ b/content/releases/qpid-proton-master/proton/c/api/group__ssl.html
@@ -94,37 +94,42 @@ $(document).ready(function(){initNavTree('group__ssl.html','');});
 <a href="#enum-members">Enumerations</a> &#124;
 <a href="#func-members">Functions</a>  </div>
   <div class="headertitle">
-<div class="title">SSL<div class="ingroups"><a class="el" href="group__engine.html">Engine</a> &raquo; <a class="el" href="group__transport.html">Transport</a></div></div>  </div>
+<div class="title">SSL<div class="ingroups"><a class="el" href="group__core.html">Core</a></div></div>  </div>
 </div><!--header-->
 <div class="contents">
+
+<p>SSL secure transport layer.  
+<a href="#details">More...</a></p>
 <table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
 Typedefs</h2></td></tr>
-<tr class="memitem:gaba83c3a1779c8b35a479bf3a7bb5b175"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaba83c3a1779c8b35a479bf3a7bb5b175"></a>
-typedef struct pn_ssl_domain_t&#160;</td><td class="memItemRight" valign="bottom"><b>pn_ssl_domain_t</b></td></tr>
+<tr class="memitem:gaba83c3a1779c8b35a479bf3a7bb5b175"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="group__ssl.html#gaba83c3a1779c8b35a479bf3a7bb5b175">pn_ssl_domain_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ssl.html#gaba83c3a1779c8b35a479bf3a7bb5b175">pn_ssl_domain_t</a></td></tr>
+<tr class="memdesc:gaba83c3a1779c8b35a479bf3a7bb5b175"><td class="mdescLeft">&#160;</td><td class="mdescRight">API for using SSL with the Transport Layer.  <a href="#gaba83c3a1779c8b35a479bf3a7bb5b175">More...</a><br /></td></tr>
 <tr class="separator:gaba83c3a1779c8b35a479bf3a7bb5b175"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ga215da63662423b00d34605ba4f9761f5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga215da63662423b00d34605ba4f9761f5"></a>
-typedef struct pn_ssl_t&#160;</td><td class="memItemRight" valign="bottom"><b>pn_ssl_t</b></td></tr>
+<tr class="memitem:ga215da63662423b00d34605ba4f9761f5"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="group__ssl.html#ga215da63662423b00d34605ba4f9761f5">pn_ssl_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ssl.html#ga215da63662423b00d34605ba4f9761f5">pn_ssl_t</a></td></tr>
 <tr class="separator:ga215da63662423b00d34605ba4f9761f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table><table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
 Enumerations</h2></td></tr>
-<tr class="memitem:ga0f1d40875c45b14a31a77f27430bc225"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ssl.html#ga0f1d40875c45b14a31a77f27430bc225">pn_ssl_mode_t</a> { <a class="el" href="group__ssl.html#gga0f1d40875c45b14a31a77f27430bc225a4e2fe24fcd2692e4c20c27668091a49c">PN_SSL_MODE_CLIENT</a> =1, 
+<tr class="memitem:ga0f1d40875c45b14a31a77f27430bc225"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ssl.html#ga0f1d40875c45b14a31a77f27430bc225">pn_ssl_mode_t</a> { <a class="el" href="group__ssl.html#gga0f1d40875c45b14a31a77f27430bc225a4e2fe24fcd2692e4c20c27668091a49c">PN_SSL_MODE_CLIENT</a>, 
 <a class="el" href="group__ssl.html#gga0f1d40875c45b14a31a77f27430bc225a0c4550c70a6bc74cb906a74c5f1e5078">PN_SSL_MODE_SERVER</a>
- }</td></tr>
+ }<tr class="memdesc:ga0f1d40875c45b14a31a77f27430bc225"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determines the type of SSL endpoint.  <a href="group__ssl.html#ga0f1d40875c45b14a31a77f27430bc225">More...</a><br /></td></tr>
+</td></tr>
 <tr class="separator:ga0f1d40875c45b14a31a77f27430bc225"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:gaf175c116d52a91001f9a3559b580f56d"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ssl.html#gaf175c116d52a91001f9a3559b580f56d">pn_ssl_resume_status_t</a> { <a class="el" href="group__ssl.html#ggaf175c116d52a91001f9a3559b580f56dad1385651f6078177d6652c385453280d">PN_SSL_RESUME_UNKNOWN</a>, 
 <a class="el" href="group__ssl.html#ggaf175c116d52a91001f9a3559b580f56dac8a5515a69c89007f681b3c555328e8f">PN_SSL_RESUME_NEW</a>, 
 <a class="el" href="group__ssl.html#ggaf175c116d52a91001f9a3559b580f56dabb1b88b78dcb91ee80cd6f0eb5873d6d">PN_SSL_RESUME_REUSED</a>
- }</td></tr>
+ }<tr class="memdesc:gaf175c116d52a91001f9a3559b580f56d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indicates whether an SSL session has been resumed.  <a href="group__ssl.html#gaf175c116d52a91001f9a3559b580f56d">More...</a><br /></td></tr>
+</td></tr>
 <tr class="separator:gaf175c116d52a91001f9a3559b580f56d"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:gae5e33024ed6af3432d4c76d1484d7ecb"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ssl.html#gae5e33024ed6af3432d4c76d1484d7ecb">pn_ssl_verify_mode_t</a> { <a class="el" href="group__ssl.html#ggae5e33024ed6af3432d4c76d1484d7ecbada1e3837cc900bd6419de72c25b253cc">PN_SSL_VERIFY_NULL</a> =0, 
+<tr class="memitem:gae5e33024ed6af3432d4c76d1484d7ecb"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ssl.html#gae5e33024ed6af3432d4c76d1484d7ecb">pn_ssl_verify_mode_t</a> { <a class="el" href="group__ssl.html#ggae5e33024ed6af3432d4c76d1484d7ecbada1e3837cc900bd6419de72c25b253cc">PN_SSL_VERIFY_NULL</a>, 
 <a class="el" href="group__ssl.html#ggae5e33024ed6af3432d4c76d1484d7ecbad80276abde5d95760c63d0b9685d4d44">PN_SSL_VERIFY_PEER</a>, 
 <a class="el" href="group__ssl.html#ggae5e33024ed6af3432d4c76d1484d7ecbafa6dbe705dd0366ff4799616f788a9f5">PN_SSL_ANONYMOUS_PEER</a>, 
 <a class="el" href="group__ssl.html#ggae5e33024ed6af3432d4c76d1484d7ecbaac956f0febf05ab579de839700895e36">PN_SSL_VERIFY_PEER_NAME</a>
- }</td></tr>
+ }<tr class="memdesc:gae5e33024ed6af3432d4c76d1484d7ecb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determines the level of peer validation.  <a href="group__ssl.html#gae5e33024ed6af3432d4c76d1484d7ecb">More...</a><br /></td></tr>
+</td></tr>
 <tr class="separator:gae5e33024ed6af3432d4c76d1484d7ecb"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ga68d52866e8172acc7ecc7b4fe5b38a40"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ssl.html#ga68d52866e8172acc7ecc7b4fe5b38a40">pn_ssl_cert_subject_subfield</a> { <br />
+<tr class="memitem:ga68d52866e8172acc7ecc7b4fe5b38a40"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga68d52866e8172acc7ecc7b4fe5b38a40"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ssl.html#ga68d52866e8172acc7ecc7b4fe5b38a40">pn_ssl_cert_subject_subfield</a> { <br />
 &#160;&#160;<b>PN_SSL_CERT_SUBJECT_COUNTRY_NAME</b>, 
 <b>PN_SSL_CERT_SUBJECT_STATE_OR_PROVINCE</b>, 
 <b>PN_SSL_CERT_SUBJECT_CITY_OR_LOCALITY</b>, 
@@ -133,82 +138,119 @@ Enumerations</h2></td></tr>
 &#160;&#160;<b>PN_SSL_CERT_SUBJECT_ORGANIZATION_UNIT</b>, 
 <b>PN_SSL_CERT_SUBJECT_COMMON_NAME</b>
 <br />
- }</td></tr>
+ }<tr class="memdesc:ga68d52866e8172acc7ecc7b4fe5b38a40"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enumeration identifying the sub fields of the subject field in the ssl certificate. <br /></td></tr>
+</td></tr>
 <tr class="separator:ga68d52866e8172acc7ecc7b4fe5b38a40"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:gaf0b0cd3271ad4a0e33e2a61a8cea7892"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ssl.html#gaf0b0cd3271ad4a0e33e2a61a8cea7892">pn_ssl_hash_alg</a> { <b>PN_SSL_SHA1</b>, 
+<tr class="memitem:gaf0b0cd3271ad4a0e33e2a61a8cea7892"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaf0b0cd3271ad4a0e33e2a61a8cea7892"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ssl.html#gaf0b0cd3271ad4a0e33e2a61a8cea7892">pn_ssl_hash_alg</a> { <b>PN_SSL_SHA1</b>, 
 <b>PN_SSL_SHA256</b>, 
 <b>PN_SSL_SHA512</b>, 
 <b>PN_SSL_MD5</b>
- }</td></tr>
+ }<tr class="memdesc:gaf0b0cd3271ad4a0e33e2a61a8cea7892"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enumeration identifying hashing algorithm. <br /></td></tr>
+</td></tr>
 <tr class="separator:gaf0b0cd3271ad4a0e33e2a61a8cea7892"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table><table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
 Functions</h2></td></tr>
-<tr class="memitem:ga94467860b566683a4c646487dc537b34"><td class="memItemLeft" align="right" valign="top">PN_EXTERN bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ssl.html#ga94467860b566683a4c646487dc537b34">pn_ssl_present</a> (void)</td></tr>
-<tr class="separator:ga94467860b566683a4c646487dc537b34"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:gabc9e5e64b23bf03316aa825ba036fb4f"><td class="memItemLeft" align="right" valign="top">PN_EXTERN pn_ssl_domain_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ssl.html#gabc9e5e64b23bf03316aa825ba036fb4f">pn_ssl_domain</a> (<a class="el" href="group__ssl.html#ga0f1d40875c45b14a31a77f27430bc225">pn_ssl_mode_t</a> mode)</td></tr>
-<tr class="separator:gabc9e5e64b23bf03316aa825ba036fb4f"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ga2f0254dda9b35b5af99e744be243daaf"><td class="memItemLeft" align="right" valign="top">PN_EXTERN void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ssl.html#ga2f0254dda9b35b5af99e744be243daaf">pn_ssl_domain_free</a> (pn_ssl_domain_t *domain)</td></tr>
-<tr class="separator:ga2f0254dda9b35b5af99e744be243daaf"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ga13bc3cf2d0d2f3f612a513752e929251"><td class="memItemLeft" align="right" valign="top">PN_EXTERN int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ssl.html#ga13bc3cf2d0d2f3f612a513752e929251">pn_ssl_domain_set_credentials</a> (pn_ssl_domain_t *domain, const char *credential_1, const char *credential_2, const char *password)</td></tr>
-<tr class="separator:ga13bc3cf2d0d2f3f612a513752e929251"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ga20761fc3f72ab4d947a7c468a43758c9"><td class="memItemLeft" align="right" valign="top">PN_EXTERN int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ssl.html#ga20761fc3f72ab4d947a7c468a43758c9">pn_ssl_domain_set_trusted_ca_db</a> (pn_ssl_domain_t *domain, const char *certificate_db)</td></tr>
-<tr class="separator:ga20761fc3f72ab4d947a7c468a43758c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:gacba0321d3d8cd67c601b604a5b42a190"><td class="memItemLeft" align="right" valign="top">PN_EXTERN int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ssl.html#gacba0321d3d8cd67c601b604a5b42a190">pn_ssl_domain_set_peer_authentication</a> (pn_ssl_domain_t *domain, const <a class="el" href="group__ssl.html#gae5e33024ed6af3432d4c76d1484d7ecb">pn_ssl_verify_mode_t</a> mode, const char *trusted_CAs)</td></tr>
-<tr class="separator:gacba0321d3d8cd67c601b604a5b42a190"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ga7bf33cfae6dcd6513da926eff993896d"><td class="memItemLeft" align="right" valign="top">PN_EXTERN int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ssl.html#ga7bf33cfae6dcd6513da926eff993896d">pn_ssl_domain_allow_unsecured_client</a> (pn_ssl_domain_t *domain)</td></tr>
-<tr class="separator:ga7bf33cfae6dcd6513da926eff993896d"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:gace9c2c01043714e64fe97a390ffeac87"><td class="memItemLeft" align="right" valign="top">PN_EXTERN pn_ssl_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ssl.html#gace9c2c01043714e64fe97a390ffeac87">pn_ssl</a> (<a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport)</td></tr>
-<tr class="separator:gace9c2c01043714e64fe97a390ffeac87"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:gac5f8d77f86808ae8401691bcd17daa77"><td class="memItemLeft" align="right" valign="top">PN_EXTERN int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ssl.html#gac5f8d77f86808ae8401691bcd17daa77">pn_ssl_init</a> (pn_ssl_t *ssl, pn_ssl_domain_t *domain, const char *session_id)</td></tr>
-<tr class="separator:gac5f8d77f86808ae8401691bcd17daa77"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ga7ea4334e4925b50cb6c6daa4795cdfa0"><td class="memItemLeft" align="right" valign="top">PN_EXTERN bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ssl.html#ga7ea4334e4925b50cb6c6daa4795cdfa0">pn_ssl_get_cipher_name</a> (pn_ssl_t *ssl, char *buffer, size_t size)</td></tr>
-<tr class="separator:ga7ea4334e4925b50cb6c6daa4795cdfa0"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ga4a1837eb135461f71da666f3438c7602"><td class="memItemLeft" align="right" valign="top">PN_EXTERN int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ssl.html#ga4a1837eb135461f71da666f3438c7602">pn_ssl_get_ssf</a> (pn_ssl_t *ssl)</td></tr>
-<tr class="separator:ga4a1837eb135461f71da666f3438c7602"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ga1636bdfcc884dbae248f0316ae2a076f"><td class="memItemLeft" align="right" valign="top">PN_EXTERN bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ssl.html#ga1636bdfcc884dbae248f0316ae2a076f">pn_ssl_get_protocol_name</a> (pn_ssl_t *ssl, char *buffer, size_t size)</td></tr>
-<tr class="separator:ga1636bdfcc884dbae248f0316ae2a076f"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ga543c4d6b34f107f41a2812b15e370523"><td class="memItemLeft" align="right" valign="top">PN_EXTERN <a class="el" href="group__ssl.html#gaf175c116d52a91001f9a3559b580f56d">pn_ssl_resume_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ssl.html#ga543c4d6b34f107f41a2812b15e370523">pn_ssl_resume_status</a> (pn_ssl_t *ssl)</td></tr>
-<tr class="separator:ga543c4d6b34f107f41a2812b15e370523"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ga733943a1e722653b5c1f36b7de670ee5"><td class="memItemLeft" align="right" valign="top">PN_EXTERN int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ssl.html#ga733943a1e722653b5c1f36b7de670ee5">pn_ssl_set_peer_hostname</a> (pn_ssl_t *ssl, const char *hostname)</td></tr>
-<tr class="separator:ga733943a1e722653b5c1f36b7de670ee5"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:gabc678b1162484ec8eeddba8b594b1f74"><td class="memItemLeft" align="right" valign="top">PN_EXTERN int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ssl.html#gabc678b1162484ec8eeddba8b594b1f74">pn_ssl_get_peer_hostname</a> (pn_ssl_t *ssl, char *hostname, size_t *bufsize)</td></tr>
-<tr class="separator:gabc678b1162484ec8eeddba8b594b1f74"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ga41e9ea2af96fcbc34fda2e72cff40f2c"><td class="memItemLeft" align="right" valign="top">PN_EXTERN const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ssl.html#ga41e9ea2af96fcbc34fda2e72cff40f2c">pn_ssl_get_remote_subject</a> (pn_ssl_t *ssl)</td></tr>
-<tr class="separator:ga41e9ea2af96fcbc34fda2e72cff40f2c"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ga31d1dde4b0fbb1cbc349863013309ba5"><td class="memItemLeft" align="right" valign="top">PN_EXTERN int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ssl.html#ga31d1dde4b0fbb1cbc349863013309ba5">pn_ssl_get_cert_fingerprint</a> (pn_ssl_t *ssl0, char *fingerprint, size_t fingerprint_length, <a class="el" href="group__ssl.html#gaf0b0cd3271ad4a0e33e2a61a8cea7892">pn_ssl_hash_alg</a> hash_alg)</td></tr>
-<tr class="separator:ga31d1dde4b0fbb1cbc349863013309ba5"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:gae6cd9e970301292a1b502a6a1d8bc2ab"><td class="memItemLeft" align="right" valign="top">PN_EXTERN const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ssl.html#gae6cd9e970301292a1b502a6a1d8bc2ab">pn_ssl_get_remote_subject_subfield</a> (pn_ssl_t *ssl0, <a class="el" href="group__ssl.html#ga68d52866e8172acc7ecc7b4fe5b38a40">pn_ssl_cert_subject_subfield</a> field)</td></tr>
-<tr class="separator:gae6cd9e970301292a1b502a6a1d8bc2ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:gaec849c8189c12da727e7be7ca757dbdb"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ssl.html#gaec849c8189c12da727e7be7ca757dbdb">pn_ssl_present</a> (void)</td></tr>
+<tr class="memdesc:gaec849c8189c12da727e7be7ca757dbdb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tests for SSL implementation present.  <a href="#gaec849c8189c12da727e7be7ca757dbdb">More...</a><br /></td></tr>
+<tr class="separator:gaec849c8189c12da727e7be7ca757dbdb"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:gaab5e86b7a4d22943eba82c6e94b82357"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ssl.html#gaba83c3a1779c8b35a479bf3a7bb5b175">pn_ssl_domain_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ssl.html#gaab5e86b7a4d22943eba82c6e94b82357">pn_ssl_domain</a> (<a class="el" href="group__ssl.html#ga0f1d40875c45b14a31a77f27430bc225">pn_ssl_mode_t</a> mode)</td></tr>
+<tr class="memdesc:gaab5e86b7a4d22943eba82c6e94b82357"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create an SSL configuration domain.  <a href="#gaab5e86b7a4d22943eba82c6e94b82357">More...</a><br /></td></tr>
+<tr class="separator:gaab5e86b7a4d22943eba82c6e94b82357"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga5452ded9c36d78a17c6dea292a01c80d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ssl.html#ga5452ded9c36d78a17c6dea292a01c80d">pn_ssl_domain_free</a> (<a class="el" href="group__ssl.html#gaba83c3a1779c8b35a479bf3a7bb5b175">pn_ssl_domain_t</a> *domain)</td></tr>
+<tr class="memdesc:ga5452ded9c36d78a17c6dea292a01c80d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Release an SSL configuration domain.  <a href="#ga5452ded9c36d78a17c6dea292a01c80d">More...</a><br /></td></tr>
+<tr class="separator:ga5452ded9c36d78a17c6dea292a01c80d"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga7311e46bb756474513f3c331e0c1b0aa"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ssl.html#ga7311e46bb756474513f3c331e0c1b0aa">pn_ssl_domain_set_credentials</a> (<a class="el" href="group__ssl.html#gaba83c3a1779c8b35a479bf3a7bb5b175">pn_ssl_domain_t</a> *domain, const char *credential_1, const char *credential_2, const char *password)</td></tr>
+<tr class="memdesc:ga7311e46bb756474513f3c331e0c1b0aa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the certificate that identifies the local node to the remote.  <a href="#ga7311e46bb756474513f3c331e0c1b0aa">More...</a><br /></td></tr>
+<tr class="separator:ga7311e46bb756474513f3c331e0c1b0aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga6cdf12ad6ff3d50ac1d31db3cff11c2d"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ssl.html#ga6cdf12ad6ff3d50ac1d31db3cff11c2d">pn_ssl_domain_set_trusted_ca_db</a> (<a class="el" href="group__ssl.html#gaba83c3a1779c8b35a479bf3a7bb5b175">pn_ssl_domain_t</a> *domain, const char *certificate_db)</td></tr>
+<tr class="memdesc:ga6cdf12ad6ff3d50ac1d31db3cff11c2d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configure the set of trusted CA certificates used by this domain to verify peers.  <a href="#ga6cdf12ad6ff3d50ac1d31db3cff11c2d">More...</a><br /></td></tr>
+<tr class="separator:ga6cdf12ad6ff3d50ac1d31db3cff11c2d"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga39b67bd22fb8f0a47bcdbdfd40f80b11"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ssl.html#ga39b67bd22fb8f0a47bcdbdfd40f80b11">pn_ssl_domain_set_peer_authentication</a> (<a class="el" href="group__ssl.html#gaba83c3a1779c8b35a479bf3a7bb5b175">pn_ssl_domain_t</a> *domain, const <a class="el" href="group__ssl.html#gae5e33024ed6af3432d4c76d1484d7ecb">pn_ssl_verify_mode_t</a> mode, const char *trusted_CAs)</td></tr>
+<tr class="memdesc:ga39b67bd22fb8f0a47bcdbdfd40f80b11"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configure the level of verification used on the peer certificate.  <a href="#ga39b67bd22fb8f0a47bcdbdfd40f80b11">More...</a><br /></td></tr>
+<tr class="separator:ga39b67bd22fb8f0a47bcdbdfd40f80b11"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga2ac989a62dcd138be770fae0bbb85e74"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ssl.html#ga2ac989a62dcd138be770fae0bbb85e74">pn_ssl_domain_allow_unsecured_client</a> (<a class="el" href="group__ssl.html#gaba83c3a1779c8b35a479bf3a7bb5b175">pn_ssl_domain_t</a> *domain)</td></tr>
+<tr class="memdesc:ga2ac989a62dcd138be770fae0bbb85e74"><td class="mdescLeft">&#160;</td><td class="mdescRight">Permit a server to accept connection requests from non-SSL clients.  <a href="#ga2ac989a62dcd138be770fae0bbb85e74">More...</a><br /></td></tr>
+<tr class="separator:ga2ac989a62dcd138be770fae0bbb85e74"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:gaaeb5284b45f9e2146ff671b1ddc9420c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ssl.html#ga215da63662423b00d34605ba4f9761f5">pn_ssl_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ssl.html#gaaeb5284b45f9e2146ff671b1ddc9420c">pn_ssl</a> (<a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport)</td></tr>
+<tr class="memdesc:gaaeb5284b45f9e2146ff671b1ddc9420c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new SSL session object associated with a transport.  <a href="#gaaeb5284b45f9e2146ff671b1ddc9420c">More...</a><br /></td></tr>
+<tr class="separator:gaaeb5284b45f9e2146ff671b1ddc9420c"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga45f319dd31ad456b8a85927888f94acf"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ssl.html#ga45f319dd31ad456b8a85927888f94acf">pn_ssl_init</a> (<a class="el" href="group__ssl.html#ga215da63662423b00d34605ba4f9761f5">pn_ssl_t</a> *ssl, <a class="el" href="group__ssl.html#gaba83c3a1779c8b35a479bf3a7bb5b175">pn_ssl_domain_t</a> *domain, const char *session_id)</td></tr>
+<tr class="memdesc:ga45f319dd31ad456b8a85927888f94acf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize an SSL session.  <a href="#ga45f319dd31ad456b8a85927888f94acf">More...</a><br /></td></tr>
+<tr class="separator:ga45f319dd31ad456b8a85927888f94acf"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga47653f84f4b5e3bad46c08d4e82a2c52"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ssl.html#ga47653f84f4b5e3bad46c08d4e82a2c52">pn_ssl_get_cipher_name</a> (<a class="el" href="group__ssl.html#ga215da63662423b00d34605ba4f9761f5">pn_ssl_t</a> *ssl, char *buffer, size_t size)</td></tr>
+<tr class="memdesc:ga47653f84f4b5e3bad46c08d4e82a2c52"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the name of the Cipher that is currently in use.  <a href="#ga47653f84f4b5e3bad46c08d4e82a2c52">More...</a><br /></td></tr>
+<tr class="separator:ga47653f84f4b5e3bad46c08d4e82a2c52"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga7fa81d6e5f9b28f90558ab8dd3c4fb1d"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ssl.html#ga7fa81d6e5f9b28f90558ab8dd3c4fb1d">pn_ssl_get_ssf</a> (<a class="el" href="group__ssl.html#ga215da63662423b00d34605ba4f9761f5">pn_ssl_t</a> *ssl)</td></tr>
+<tr class="memdesc:ga7fa81d6e5f9b28f90558ab8dd3c4fb1d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the SSF (security strength factor) of the Cipher that is currently in use.  <a href="#ga7fa81d6e5f9b28f90558ab8dd3c4fb1d">More...</a><br /></td></tr>
+<tr class="separator:ga7fa81d6e5f9b28f90558ab8dd3c4fb1d"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga03e8070271747c3901d8d6e5710c0066"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ssl.html#ga03e8070271747c3901d8d6e5710c0066">pn_ssl_get_protocol_name</a> (<a class="el" href="group__ssl.html#ga215da63662423b00d34605ba4f9761f5">pn_ssl_t</a> *ssl, char *buffer, size_t size)</td></tr>
+<tr class="memdesc:ga03e8070271747c3901d8d6e5710c0066"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the name of the SSL protocol that is currently in use.  <a href="#ga03e8070271747c3901d8d6e5710c0066">More...</a><br /></td></tr>
+<tr class="separator:ga03e8070271747c3901d8d6e5710c0066"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga5f1a1d6697994bac00edc3df200a8f5f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ssl.html#gaf175c116d52a91001f9a3559b580f56d">pn_ssl_resume_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ssl.html#ga5f1a1d6697994bac00edc3df200a8f5f">pn_ssl_resume_status</a> (<a class="el" href="group__ssl.html#ga215da63662423b00d34605ba4f9761f5">pn_ssl_t</a> *ssl)</td></tr>
+<tr class="memdesc:ga5f1a1d6697994bac00edc3df200a8f5f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check whether the state has been resumed.  <a href="#ga5f1a1d6697994bac00edc3df200a8f5f">More...</a><br /></td></tr>
+<tr class="separator:ga5f1a1d6697994bac00edc3df200a8f5f"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga15d46dcd823ebd42b9f7f63ed570080a"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ssl.html#ga15d46dcd823ebd42b9f7f63ed570080a">pn_ssl_set_peer_hostname</a> (<a class="el" href="group__ssl.html#ga215da63662423b00d34605ba4f9761f5">pn_ssl_t</a> *ssl, const char *hostname)</td></tr>
+<tr class="memdesc:ga15d46dcd823ebd42b9f7f63ed570080a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the expected identity of the remote peer.  <a href="#ga15d46dcd823ebd42b9f7f63ed570080a">More...</a><br /></td></tr>
+<tr class="separator:ga15d46dcd823ebd42b9f7f63ed570080a"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga76636a5ce4696284356321226ee0731c"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ssl.html#ga76636a5ce4696284356321226ee0731c">pn_ssl_get_peer_hostname</a> (<a class="el" href="group__ssl.html#ga215da63662423b00d34605ba4f9761f5">pn_ssl_t</a> *ssl, char *hostname, size_t *bufsize)</td></tr>
+<tr class="memdesc:ga76636a5ce4696284356321226ee0731c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Access the configured peer identity.  <a href="#ga76636a5ce4696284356321226ee0731c">More...</a><br /></td></tr>
+<tr class="separator:ga76636a5ce4696284356321226ee0731c"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga11c877302188bc852cfdc9efd6de58c3"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ssl.html#ga11c877302188bc852cfdc9efd6de58c3">pn_ssl_get_remote_subject</a> (<a class="el" href="group__ssl.html#ga215da63662423b00d34605ba4f9761f5">pn_ssl_t</a> *ssl)</td></tr>
+<tr class="memdesc:ga11c877302188bc852cfdc9efd6de58c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the subject from the peers certificate.  <a href="#ga11c877302188bc852cfdc9efd6de58c3">More...</a><br /></td></tr>
+<tr class="separator:ga11c877302188bc852cfdc9efd6de58c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga324db5da83b1abad2e948481d65119d4"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ssl.html#ga324db5da83b1abad2e948481d65119d4">pn_ssl_get_cert_fingerprint</a> (<a class="el" href="group__ssl.html#ga215da63662423b00d34605ba4f9761f5">pn_ssl_t</a> *ssl0, char *fingerprint, size_t fingerprint_length, <a class="el" href="group__ssl.html#gaf0b0cd3271ad4a0e33e2a61a8cea7892">pn_ssl_hash_alg</a> hash_alg)</td></tr>
+<tr class="memdesc:ga324db5da83b1abad2e948481d65119d4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the fingerprint of the certificate.  <a href="#ga324db5da83b1abad2e948481d65119d4">More...</a><br /></td></tr>
+<tr class="separator:ga324db5da83b1abad2e948481d65119d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga0c9e8827536b9929793045771d82bdf1"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ssl.html#ga0c9e8827536b9929793045771d82bdf1">pn_ssl_get_remote_subject_subfield</a> (<a class="el" href="group__ssl.html#ga215da63662423b00d34605ba4f9761f5">pn_ssl_t</a> *ssl0, <a class="el" href="group__ssl.html#ga68d52866e8172acc7ecc7b4fe5b38a40">pn_ssl_cert_subject_subfield</a> field)</td></tr>
+<tr class="memdesc:ga0c9e8827536b9929793045771d82bdf1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a char pointer that contains the value of the sub field of the subject field in the ssl certificate.  <a href="#ga0c9e8827536b9929793045771d82bdf1">More...</a><br /></td></tr>
+<tr class="separator:ga0c9e8827536b9929793045771d82bdf1"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
-<h2 class="groupheader">Enumeration Type Documentation</h2>
-<a class="anchor" id="ga68d52866e8172acc7ecc7b4fe5b38a40"></a>
+<p>SSL secure transport layer. </p>
+<h2 class="groupheader">Typedef Documentation</h2>
+<a class="anchor" id="gaba83c3a1779c8b35a479bf3a7bb5b175"></a>
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
-          <td class="memname">enum <a class="el" href="group__ssl.html#ga68d52866e8172acc7ecc7b4fe5b38a40">pn_ssl_cert_subject_subfield</a></td>
+          <td class="memname">typedef struct <a class="el" href="group__ssl.html#gaba83c3a1779c8b35a479bf3a7bb5b175">pn_ssl_domain_t</a> <a class="el" href="group__ssl.html#gaba83c3a1779c8b35a479bf3a7bb5b175">pn_ssl_domain_t</a></td>
         </tr>
       </table>
 </div><div class="memdoc">
-<p>Enumeration identifying the sub fields of the subject field in the ssl certificate. </p>
+
+<p>API for using SSL with the Transport Layer. </p>
+<p>A Transport may be configured to use SSL for encryption and/or authentication. A Transport can be configured as either an "SSL client" or an "SSL server". An SSL client is the party that proactively establishes a connection to an SSL server. An SSL server is the party that accepts a connection request from a remote SSL client.</p>
+<p>This SSL implementation defines the following objects:</p>
+<ul>
+<li>A top-level object that stores the configuration used by one or more SSL sessions (pn_ssl_domain_t). </li>
+<li>A per-connection SSL session object that performs the encryption/authentication associated with the transport (pn_ssl_t). </li>
+<li>The encryption parameters negotiated for the SSL session (pn_ssl_state_t).</li>
+</ul>
+<p>A pn_ssl_domain_t object must be created and configured before an SSL session can be established. The pn_ssl_domain_t is used to construct an SSL session (pn_ssl_t). The session "adopts" its configuration from the pn_ssl_domain_t that was used to create it. For example, pn_ssl_domain_t can be configured as either a "client" or a "server". SSL sessions constructed from this domain will perform the corresponding role (either client or server).</p>
+<p>If either an SSL server or client needs to identify itself with the remote node, it must have its SSL certificate configured (see <a class="el" href="group__ssl.html#ga7311e46bb756474513f3c331e0c1b0aa" title="Set the certificate that identifies the local node to the remote. ">pn_ssl_domain_set_credentials()</a>).</p>
+<p>If either an SSL server or client needs to verify the identity of the remote node, it must have its database of trusted CAs configured (see <a class="el" href="group__ssl.html#ga6cdf12ad6ff3d50ac1d31db3cff11c2d" title="Configure the set of trusted CA certificates used by this domain to verify peers. ...">pn_ssl_domain_set_trusted_ca_db()</a>).</p>
+<p>An SSL server connection may allow the remote client to connect without SSL (eg. "in
+the clear"), see <a class="el" href="group__ssl.html#ga2ac989a62dcd138be770fae0bbb85e74" title="Permit a server to accept connection requests from non-SSL clients. ">pn_ssl_domain_allow_unsecured_client()</a>.</p>
+<p>The level of verification required of the remote may be configured (see <a class="el" href="group__ssl.html#ga39b67bd22fb8f0a47bcdbdfd40f80b11" title="Configure the level of verification used on the peer certificate. ">pn_ssl_domain_set_peer_authentication</a>)</p>
+<p>Support for SSL Client Session resume is provided (see <a class="el" href="group__ssl.html#ga45f319dd31ad456b8a85927888f94acf" title="Initialize an SSL session. ">pn_ssl_init</a>, <a class="el" href="group__ssl.html#ga5f1a1d6697994bac00edc3df200a8f5f" title="Check whether the state has been resumed. ">pn_ssl_resume_status</a>). </p>
 
 </div>
 </div>
-<a class="anchor" id="gaf0b0cd3271ad4a0e33e2a61a8cea7892"></a>
+<a class="anchor" id="ga215da63662423b00d34605ba4f9761f5"></a>
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
-          <td class="memname">enum <a class="el" href="group__ssl.html#gaf0b0cd3271ad4a0e33e2a61a8cea7892">pn_ssl_hash_alg</a></td>
+          <td class="memname">typedef struct <a class="el" href="group__ssl.html#ga215da63662423b00d34605ba4f9761f5">pn_ssl_t</a> <a class="el" href="group__ssl.html#ga215da63662423b00d34605ba4f9761f5">pn_ssl_t</a></td>
         </tr>
       </table>
 </div><div class="memdoc">
-<p>Enumeration identifying hashing algorithm. </p>
+<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__ssl.html#gaaeb5284b45f9e2146ff671b1ddc9420c" title="Create a new SSL session object associated with a transport. ">pn_ssl</a> </dd></dl>
 
 </div>
 </div>
+<h2 class="groupheader">Enumeration Type Documentation</h2>
 <a class="anchor" id="ga0f1d40875c45b14a31a77f27430bc225"></a>
 <div class="memitem">
 <div class="memproto">
@@ -218,13 +260,14 @@ Functions</h2></td></tr>
         </tr>
       </table>
 </div><div class="memdoc">
+
 <p>Determines the type of SSL endpoint. </p>
 <table class="fieldtable">
 <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="gga0f1d40875c45b14a31a77f27430bc225a4e2fe24fcd2692e4c20c27668091a49c"></a>PN_SSL_MODE_CLIENT&#160;</td><td class="fielddoc">
-<p>Local connection endpoint is an SSL client </p>
+<p>Local connection endpoint is an SSL client. </p>
 </td></tr>
 <tr><td class="fieldname"><a class="anchor" id="gga0f1d40875c45b14a31a77f27430bc225a0c4550c70a6bc74cb906a74c5f1e5078"></a>PN_SSL_MODE_SERVER&#160;</td><td class="fielddoc">
-<p>Local connection endpoint is an SSL server </p>
+<p>Local connection endpoint is an SSL server. </p>
 </td></tr>
 </table>
 
@@ -239,13 +282,14 @@ Functions</h2></td></tr>
         </tr>
       </table>
 </div><div class="memdoc">
+
 <p>Indicates whether an SSL session has been resumed. </p>
 <table class="fieldtable">
 <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="ggaf175c116d52a91001f9a3559b580f56dad1385651f6078177d6652c385453280d"></a>PN_SSL_RESUME_UNKNOWN&#160;</td><td class="fielddoc">
-<p>Session resume state unknown/not supported </p>
+<p>Session resume state unknown/not supported. </p>
 </td></tr>
 <tr><td class="fieldname"><a class="anchor" id="ggaf175c116d52a91001f9a3559b580f56dac8a5515a69c89007f681b3c555328e8f"></a>PN_SSL_RESUME_NEW&#160;</td><td class="fielddoc">
-<p>Session renegotiated - not resumed </p>
+<p>Session renegotiated - not resumed. </p>
 </td></tr>
 <tr><td class="fieldname"><a class="anchor" id="ggaf175c116d52a91001f9a3559b580f56dabb1b88b78dcb91ee80cd6f0eb5873d6d"></a>PN_SSL_RESUME_REUSED&#160;</td><td class="fielddoc">
 <p>Session resumed from previous session. </p>
@@ -263,10 +307,11 @@ Functions</h2></td></tr>
         </tr>
       </table>
 </div><div class="memdoc">
-<p>Determines the level of peer validation.</p>
+
+<p>Determines the level of peer validation. </p>
 <p>ANONYMOUS_PEER does not require a valid certificate, and permits use of ciphers that do not provide authentication.</p>
 <p>VERIFY_PEER will only connect to those peers that provide a valid identifying certificate signed by a trusted CA and are using an authenticated cipher.</p>
-<p>VERIFY_PEER_NAME is like VERIFY_PEER, but also requires the peer's identity as contained in the certificate to be valid (see <a class="el" href="group__ssl.html#ga733943a1e722653b5c1f36b7de670ee5">pn_ssl_set_peer_hostname</a>).</p>
+<p>VERIFY_PEER_NAME is like VERIFY_PEER, but also requires the peer's identity as contained in the certificate to be valid (see <a class="el" href="group__ssl.html#ga15d46dcd823ebd42b9f7f63ed570080a" title="Set the expected identity of the remote peer. ">pn_ssl_set_peer_hostname</a>).</p>
 <p>ANONYMOUS_PEER is configured by default. </p>
 <table class="fieldtable">
 <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="ggae5e33024ed6af3432d4c76d1484d7ecbada1e3837cc900bd6419de72c25b253cc"></a>PN_SSL_VERIFY_NULL&#160;</td><td class="fielddoc">
@@ -286,12 +331,12 @@ Functions</h2></td></tr>
 </div>
 </div>
 <h2 class="groupheader">Function Documentation</h2>
-<a class="anchor" id="gace9c2c01043714e64fe97a390ffeac87"></a>
+<a class="anchor" id="gaaeb5284b45f9e2146ff671b1ddc9420c"></a>
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
-          <td class="memname">PN_EXTERN pn_ssl_t* pn_ssl </td>
+          <td class="memname"><a class="el" href="group__ssl.html#ga215da63662423b00d34605ba4f9761f5">pn_ssl_t</a>* pn_ssl </td>
           <td>(</td>
           <td class="paramtype"><a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *&#160;</td>
           <td class="paramname"><em>transport</em></td><td>)</td>
@@ -299,7 +344,8 @@ Functions</h2></td></tr>
         </tr>
       </table>
 </div><div class="memdoc">
-<p>Create a new SSL session object associated with a transport.</p>
+
+<p>Create a new SSL session object associated with a transport. </p>
 <p>A transport must have an SSL object in order to "speak" SSL over its connection. This method allocates an SSL object associates it with the transport.</p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
@@ -311,12 +357,12 @@ Functions</h2></td></tr>
 
 </div>
 </div>
-<a class="anchor" id="gabc9e5e64b23bf03316aa825ba036fb4f"></a>
+<a class="anchor" id="gaab5e86b7a4d22943eba82c6e94b82357"></a>
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
-          <td class="memname">PN_EXTERN pn_ssl_domain_t* pn_ssl_domain </td>
+          <td class="memname"><a class="el" href="group__ssl.html#gaba83c3a1779c8b35a479bf3a7bb5b175">pn_ssl_domain_t</a>* pn_ssl_domain </td>
           <td>(</td>
           <td class="paramtype"><a class="el" href="group__ssl.html#ga0f1d40875c45b14a31a77f27430bc225">pn_ssl_mode_t</a>&#160;</td>
           <td class="paramname"><em>mode</em></td><td>)</td>
@@ -324,7 +370,8 @@ Functions</h2></td></tr>
         </tr>
       </table>
 </div><div class="memdoc">
-<p>Create an SSL configuration domain</p>
+
+<p>Create an SSL configuration domain. </p>
 <p>This method allocates an SSL domain object. This object is used to hold the SSL configuration for one or more SSL sessions. The SSL session object (pn_ssl_t) is allocated from this object.</p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
@@ -336,20 +383,21 @@ Functions</h2></td></tr>
 
 </div>
 </div>
-<a class="anchor" id="ga7bf33cfae6dcd6513da926eff993896d"></a>
+<a class="anchor" id="ga2ac989a62dcd138be770fae0bbb85e74"></a>
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
-          <td class="memname">PN_EXTERN int pn_ssl_domain_allow_unsecured_client </td>
+          <td class="memname">int pn_ssl_domain_allow_unsecured_client </td>
           <td>(</td>
-          <td class="paramtype">pn_ssl_domain_t *&#160;</td>
+          <td class="paramtype"><a class="el" href="group__ssl.html#gaba83c3a1779c8b35a479bf3a7bb5b175">pn_ssl_domain_t</a> *&#160;</td>
           <td class="paramname"><em>domain</em></td><td>)</td>
           <td></td>
         </tr>
       </table>
 </div><div class="memdoc">
-<p>Permit a server to accept connection requests from non-SSL clients.</p>
+
+<p>Permit a server to accept connection requests from non-SSL clients. </p>
 <p>This configures the server to "sniff" the incoming client data stream, and dynamically determine whether SSL/TLS is being used. This option is disabled by default: only clients using SSL/TLS are accepted.</p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
@@ -361,21 +409,22 @@ Functions</h2></td></tr>
 
 </div>
 </div>
-<a class="anchor" id="ga2f0254dda9b35b5af99e744be243daaf"></a>
+<a class="anchor" id="ga5452ded9c36d78a17c6dea292a01c80d"></a>
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
-          <td class="memname">PN_EXTERN void pn_ssl_domain_free </td>
+          <td class="memname">void pn_ssl_domain_free </td>
           <td>(</td>
-          <td class="paramtype">pn_ssl_domain_t *&#160;</td>
+          <td class="paramtype"><a class="el" href="group__ssl.html#gaba83c3a1779c8b35a479bf3a7bb5b175">pn_ssl_domain_t</a> *&#160;</td>
           <td class="paramname"><em>domain</em></td><td>)</td>
           <td></td>
         </tr>
       </table>
 </div><div class="memdoc">
-<p>Release an SSL configuration domain</p>
-<p>This method frees an SSL domain object allocated by <a class="el" href="group__ssl.html#gabc9e5e64b23bf03316aa825ba036fb4f">pn_ssl_domain</a>. </p><dl class="params"><dt>Parameters</dt><dd>
+
+<p>Release an SSL configuration domain. </p>
+<p>This method frees an SSL domain object allocated by <a class="el" href="group__ssl.html#gaab5e86b7a4d22943eba82c6e94b82357" title="Create an SSL configuration domain. ">pn_ssl_domain</a>. </p><dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramdir">[in]</td><td class="paramname">domain</td><td>the domain to destroy. </td></tr>
   </table>
@@ -384,14 +433,14 @@ Functions</h2></td></tr>
 
 </div>
 </div>
-<a class="anchor" id="ga13bc3cf2d0d2f3f612a513752e929251"></a>
+<a class="anchor" id="ga7311e46bb756474513f3c331e0c1b0aa"></a>
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
-          <td class="memname">PN_EXTERN int pn_ssl_domain_set_credentials </td>
+          <td class="memname">int pn_ssl_domain_set_credentials </td>
           <td>(</td>
-          <td class="paramtype">pn_ssl_domain_t *&#160;</td>
+          <td class="paramtype"><a class="el" href="group__ssl.html#gaba83c3a1779c8b35a479bf3a7bb5b175">pn_ssl_domain_t</a> *&#160;</td>
           <td class="paramname"><em>domain</em>, </td>
         </tr>
         <tr>
@@ -419,7 +468,8 @@ Functions</h2></td></tr>
         </tr>
       </table>
 </div><div class="memdoc">
-<p>Set the certificate that identifies the local node to the remote.</p>
+
+<p>Set the certificate that identifies the local node to the remote. </p>
 <p>This certificate establishes the identity for the local node for all SSL sessions created from this domain. It will be sent to the remote if the remote needs to verify the identity of this node. This may be used for both SSL servers and SSL clients (if client authentication is required by the server).</p>
 <dl class="section note"><dt>Note</dt><dd>This setting effects only those pn_ssl_t objects created after this call returns. pn_ssl_t objects created before invoking this method will use the domain's previous setting.</dd></dl>
 <dl class="params"><dt>Parameters</dt><dd>
@@ -435,14 +485,14 @@ Functions</h2></td></tr>
 
 </div>
 </div>
-<a class="anchor" id="gacba0321d3d8cd67c601b604a5b42a190"></a>
+<a class="anchor" id="ga39b67bd22fb8f0a47bcdbdfd40f80b11"></a>
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
-          <td class="memname">PN_EXTERN int pn_ssl_domain_set_peer_authentication </td>
+          <td class="memname">int pn_ssl_domain_set_peer_authentication </td>
           <td>(</td>
-          <td class="paramtype">pn_ssl_domain_t *&#160;</td>
+          <td class="paramtype"><a class="el" href="group__ssl.html#gaba83c3a1779c8b35a479bf3a7bb5b175">pn_ssl_domain_t</a> *&#160;</td>
           <td class="paramname"><em>domain</em>, </td>
         </tr>
         <tr>
@@ -464,11 +514,12 @@ Functions</h2></td></tr>
         </tr>
       </table>
 </div><div class="memdoc">
-<p>Configure the level of verification used on the peer certificate.</p>
+
+<p>Configure the level of verification used on the peer certificate. </p>
 <p>This method controls how the peer's certificate is validated, if at all. By default, neither servers nor clients attempt to verify their peers (PN_SSL_ANONYMOUS_PEER). Once certificates and trusted CAs are configured, peer verification can be enabled.</p>
-<dl class="section note"><dt>Note</dt><dd>In order to verify a peer, a trusted CA must be configured. See <a class="el" href="group__ssl.html#ga20761fc3f72ab4d947a7c468a43758c9">pn_ssl_domain_set_trusted_ca_db()</a>.</dd>
+<dl class="section note"><dt>Note</dt><dd>In order to verify a peer, a trusted CA must be configured. See <a class="el" href="group__ssl.html#ga6cdf12ad6ff3d50ac1d31db3cff11c2d" title="Configure the set of trusted CA certificates used by this domain to verify peers. ...">pn_ssl_domain_set_trusted_ca_db()</a>.</dd>
 <dd>
-Servers must provide their own certificate when verifying a peer. See <a class="el" href="group__ssl.html#ga13bc3cf2d0d2f3f612a513752e929251">pn_ssl_domain_set_credentials()</a>.</dd>
+Servers must provide their own certificate when verifying a peer. See <a class="el" href="group__ssl.html#ga7311e46bb756474513f3c331e0c1b0aa" title="Set the certificate that identifies the local node to the remote. ">pn_ssl_domain_set_credentials()</a>.</dd>
 <dd>
 This setting effects only those pn_ssl_t objects created after this call returns. pn_ssl_t objects created before invoking this method will use the domain's previous setting.</dd></dl>
 <dl class="params"><dt>Parameters</dt><dd>
@@ -483,14 +534,14 @@ This setting effects only those pn_ssl_t objects created after this call returns
 
 </div>
 </div>
-<a class="anchor" id="ga20761fc3f72ab4d947a7c468a43758c9"></a>
+<a class="anchor" id="ga6cdf12ad6ff3d50ac1d31db3cff11c2d"></a>
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
-          <td class="memname">PN_EXTERN int pn_ssl_domain_set_trusted_ca_db </td>
+          <td class="memname">int pn_ssl_domain_set_trusted_ca_db </td>
           <td>(</td>
-          <td class="paramtype">pn_ssl_domain_t *&#160;</td>
+          <td class="paramtype"><a class="el" href="group__ssl.html#gaba83c3a1779c8b35a479bf3a7bb5b175">pn_ssl_domain_t</a> *&#160;</td>
           <td class="paramname"><em>domain</em>, </td>
         </tr>
         <tr>
@@ -506,7 +557,8 @@ This setting effects only those pn_ssl_t objects created after this call returns
         </tr>
       </table>
 </div><div class="memdoc">
-<p>Configure the set of trusted CA certificates used by this domain to verify peers.</p>
+
+<p>Configure the set of trusted CA certificates used by this domain to verify peers. </p>
 <p>If the local SSL client/server needs to verify the identity of the remote, it must validate the signature of the remote's certificate. This function sets the database of trusted CAs that will be used to verify the signature of the remote's certificate.</p>
 <dl class="section note"><dt>Note</dt><dd>This setting effects only those pn_ssl_t objects created after this call returns. pn_ssl_t objects created before invoking this method will use the domain's previous setting.</dd></dl>
 <dl class="params"><dt>Parameters</dt><dd>
@@ -520,14 +572,14 @@ This setting effects only those pn_ssl_t objects created after this call returns
 
 </div>
 </div>
-<a class="anchor" id="ga31d1dde4b0fbb1cbc349863013309ba5"></a>
+<a class="anchor" id="ga324db5da83b1abad2e948481d65119d4"></a>
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
-          <td class="memname">PN_EXTERN int pn_ssl_get_cert_fingerprint </td>
+          <td class="memname">int pn_ssl_get_cert_fingerprint </td>
           <td>(</td>
-          <td class="paramtype">pn_ssl_t *&#160;</td>
+          <td class="paramtype"><a class="el" href="group__ssl.html#ga215da63662423b00d34605ba4f9761f5">pn_ssl_t</a> *&#160;</td>
           <td class="paramname"><em>ssl0</em>, </td>
         </tr>
         <tr>
@@ -555,7 +607,9 @@ This setting effects only those pn_ssl_t objects created after this call returns
         </tr>
       </table>
 </div><div class="memdoc">
-<p>Get the fingerprint of the certificate. The certificate fingerprint (as displayed in the Fingerprints section when looking at a certificate with say the Firefox browser) is the hexadecimal hash of the entire certificate. The fingerprint is not part of the certificate, rather it is computed from the certificate and can be used to uniquely identify a certificate. </p><dl class="params"><dt>Parameters</dt><dd>
+
+<p>Get the fingerprint of the certificate. </p>
+<p>The certificate fingerprint (as displayed in the Fingerprints section when looking at a certificate with say the Firefox browser) is the hexadecimal hash of the entire certificate. The fingerprint is not part of the certificate, rather it is computed from the certificate and can be used to uniquely identify a certificate. </p><dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramdir">[in]</td><td class="paramname">ssl0</td><td>the ssl client/server to query </td></tr>
     <tr><td class="paramdir">[in]</td><td class="paramname">fingerprint</td><td>char pointer. The certificate fingerprint (in hex format) will be populated in this array. If sha1 is the digest name, the fingerprint is 41 characters long (40 + 1 '\0' character), 65 characters long for sha256 and 129 characters long for sha512 and 33 characters for md5. </td></tr>
@@ -568,14 +622,14 @@ This setting effects only those pn_ssl_t objects created after this call returns
 
 </div>
 </div>
-<a class="anchor" id="ga7ea4334e4925b50cb6c6daa4795cdfa0"></a>
+<a class="anchor" id="ga47653f84f4b5e3bad46c08d4e82a2c52"></a>
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
-          <td class="memname">PN_EXTERN bool pn_ssl_get_cipher_name </td>
+          <td class="memname">bool pn_ssl_get_cipher_name </td>
           <td>(</td>
-          <td class="paramtype">pn_ssl_t *&#160;</td>
+          <td class="paramtype"><a class="el" href="group__ssl.html#ga215da63662423b00d34605ba4f9761f5">pn_ssl_t</a> *&#160;</td>
           <td class="paramname"><em>ssl</em>, </td>
         </tr>
         <tr>
@@ -597,7 +651,8 @@ This setting effects only those pn_ssl_t objects created after this call returns
         </tr>
       </table>
 </div><div class="memdoc">
-<p>Get the name of the Cipher that is currently in use.</p>
+
+<p>Get the name of the Cipher that is currently in use. </p>
 <p>Gets a text description of the cipher that is currently active, or returns FALSE if SSL is not active (no cipher). Note that the cipher in use may change over time due to renegotiation or other changes to the SSL state.</p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
@@ -611,14 +666,14 @@ This setting effects only those pn_ssl_t objects created after this call returns
 
 </div>
 </div>
-<a class="anchor" id="gabc678b1162484ec8eeddba8b594b1f74"></a>
+<a class="anchor" id="ga76636a5ce4696284356321226ee0731c"></a>
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
-          <td class="memname">PN_EXTERN int pn_ssl_get_peer_hostname </td>
+          <td class="memname">int pn_ssl_get_peer_hostname </td>
           <td>(</td>
-          <td class="paramtype">pn_ssl_t *&#160;</td>
+          <td class="paramtype"><a class="el" href="group__ssl.html#ga215da63662423b00d34605ba4f9761f5">pn_ssl_t</a> *&#160;</td>
           <td class="paramname"><em>ssl</em>, </td>
         </tr>
         <tr>
@@ -640,8 +695,9 @@ This setting effects only those pn_ssl_t objects created after this call returns
         </tr>
       </table>
 </div><div class="memdoc">
-<p>Access the configured peer identity.</p>
-<p>Return the expected identity of the remote peer, as set by <a class="el" href="group__ssl.html#ga733943a1e722653b5c1f36b7de670ee5">pn_ssl_set_peer_hostname</a>.</p>
+
+<p>Access the configured peer identity. </p>
+<p>Return the expected identity of the remote peer, as set by <a class="el" href="group__ssl.html#ga15d46dcd823ebd42b9f7f63ed570080a" title="Set the expected identity of the remote peer. ">pn_ssl_set_peer_hostname</a>.</p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramdir">[in]</td><td class="paramname">ssl</td><td>the ssl session. </td></tr>
@@ -654,14 +710,14 @@ This setting effects only those pn_ssl_t objects created after this call returns
 
 </div>
 </div>
-<a class="anchor" id="ga1636bdfcc884dbae248f0316ae2a076f"></a>
+<a class="anchor" id="ga03e8070271747c3901d8d6e5710c0066"></a>
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
-          <td class="memname">PN_EXTERN bool pn_ssl_get_protocol_name </td>
+          <td class="memname">bool pn_ssl_get_protocol_name </td>
           <td>(</td>
-          <td class="paramtype">pn_ssl_t *&#160;</td>
+          <td class="paramtype"><a class="el" href="group__ssl.html#ga215da63662423b00d34605ba4f9761f5">pn_ssl_t</a> *&#160;</td>
           <td class="paramname"><em>ssl</em>, </td>
         </tr>
         <tr>
@@ -683,7 +739,8 @@ This setting effects only those pn_ssl_t objects created after this call returns
         </tr>
       </table>
 </div><div class="memdoc">
-<p>Get the name of the SSL protocol that is currently in use.</p>
+
+<p>Get the name of the SSL protocol that is currently in use. </p>
 <p>Gets a text description of the SSL protocol that is currently active, or returns FALSE if SSL is not active. Note that the protocol may change over time due to renegotiation.</p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
@@ -697,20 +754,21 @@ This setting effects only those pn_ssl_t objects created after this call returns
 
 </div>
 </div>
-<a class="anchor" id="ga41e9ea2af96fcbc34fda2e72cff40f2c"></a>
+<a class="anchor" id="ga11c877302188bc852cfdc9efd6de58c3"></a>
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
-          <td class="memname">PN_EXTERN const char* pn_ssl_get_remote_subject </td>
+          <td class="memname">const char* pn_ssl_get_remote_subject </td>
           <td>(</td>
-          <td class="paramtype">pn_ssl_t *&#160;</td>
+          <td class="paramtype"><a class="el" href="group__ssl.html#ga215da63662423b00d34605ba4f9761f5">pn_ssl_t</a> *&#160;</td>
           <td class="paramname"><em>ssl</em></td><td>)</td>
           <td></td>
         </tr>
       </table>
 </div><div class="memdoc">
-<p>Get the subject from the peers certificate.</p>
+
+<p>Get the subject from the peers certificate. </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramdir">[in]</td><td class="paramname">ssl</td><td>the ssl client/server to query. </td></tr>
@@ -721,14 +779,14 @@ This setting effects only those pn_ssl_t objects created after this call returns
 
 </div>
 </div>
-<a class="anchor" id="gae6cd9e970301292a1b502a6a1d8bc2ab"></a>
+<a class="anchor" id="ga0c9e8827536b9929793045771d82bdf1"></a>
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
-          <td class="memname">PN_EXTERN const char* pn_ssl_get_remote_subject_subfield </td>
+          <td class="memname">const char* pn_ssl_get_remote_subject_subfield </td>
           <td>(</td>
-          <td class="paramtype">pn_ssl_t *&#160;</td>
+          <td class="paramtype"><a class="el" href="group__ssl.html#ga215da63662423b00d34605ba4f9761f5">pn_ssl_t</a> *&#160;</td>
           <td class="paramname"><em>ssl0</em>, </td>
         </tr>
         <tr>
@@ -744,7 +802,9 @@ This setting effects only those pn_ssl_t objects created after this call returns
         </tr>
       </table>
 </div><div class="memdoc">
-<p>Returns a char pointer that contains the value of the sub field of the subject field in the ssl certificate. The subject field usually contains the following sub fields - C = ISO3166 two character country code ST = state or province L = Locality; generally means city O = Organization - Company Name OU = Organization Unit - division or unit CN = CommonName </p><dl class="params"><dt>Parameters</dt><dd>
+
+<p>Returns a char pointer that contains the value of the sub field of the subject field in the ssl certificate. </p>
+<p>The subject field usually contains the following sub fields - C = ISO3166 two character country code ST = state or province L = Locality; generally means city O = Organization - Company Name OU = Organization Unit - division or unit CN = CommonName </p><dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramdir">[in]</td><td class="paramname">ssl0</td><td>the ssl client/server to query </td></tr>
     <tr><td class="paramdir">[in]</td><td class="paramname">field</td><td>The enumeration pn_ssl_cert_subject_subfield representing the required sub field. </td></tr>
@@ -755,20 +815,21 @@ This setting effects only those pn_ssl_t objects created after this call returns
 
 </div>
 </div>
-<a class="anchor" id="ga4a1837eb135461f71da666f3438c7602"></a>
+<a class="anchor" id="ga7fa81d6e5f9b28f90558ab8dd3c4fb1d"></a>
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
-          <td class="memname">PN_EXTERN int pn_ssl_get_ssf </td>
+          <td class="memname">int pn_ssl_get_ssf </td>
           <td>(</td>
-          <td class="paramtype">pn_ssl_t *&#160;</td>
+          <td class="paramtype"><a class="el" href="group__ssl.html#ga215da63662423b00d34605ba4f9761f5">pn_ssl_t</a> *&#160;</td>
           <td class="paramname"><em>ssl</em></td><td>)</td>
           <td></td>
         </tr>
       </table>
 </div><div class="memdoc">
-<p>Get the SSF (security strength factor) of the Cipher that is currently in use.</p>
+
+<p>Get the SSF (security strength factor) of the Cipher that is currently in use. </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramdir">[in]</td><td class="paramname">ssl</td><td>the ssl client/server to query. </td></tr>
@@ -779,20 +840,20 @@ This setting effects only those pn_ssl_t objects created after this call returns
 
 </div>
 </div>
-<a class="anchor" id="gac5f8d77f86808ae8401691bcd17daa77"></a>
+<a class="anchor" id="ga45f319dd31ad456b8a85927888f94acf"></a>
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
-          <td class="memname">PN_EXTERN int pn_ssl_init </td>
+          <td class="memname">int pn_ssl_init </td>
           <td>(</td>
-          <td class="paramtype">pn_ssl_t *&#160;</td>
+          <td class="paramtype"><a class="el" href="group__ssl.html#ga215da63662423b00d34605ba4f9761f5">pn_ssl_t</a> *&#160;</td>
           <td class="paramname"><em>ssl</em>, </td>
         </tr>
         <tr>
           <td class="paramkey"></td>
           <td></td>
-          <td class="paramtype">pn_ssl_domain_t *&#160;</td>
+          <td class="paramtype"><a class="el" href="group__ssl.html#gaba83c3a1779c8b35a479bf3a7bb5b175">pn_ssl_domain_t</a> *&#160;</td>
           <td class="paramname"><em>domain</em>, </td>
         </tr>
         <tr>
@@ -808,13 +869,14 @@ This setting effects only those pn_ssl_t objects created after this call returns
         </tr>
       </table>
 </div><div class="memdoc">
-<p>Initialize an SSL session.</p>
+
+<p>Initialize an SSL session. </p>
 <p>This method configures an SSL object using the configuration provided by the given domain.</p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramdir">[in]</td><td class="paramname">ssl</td><td>the ssl session to configured. </td></tr>
     <tr><td class="paramdir">[in]</td><td class="paramname">domain</td><td>the ssl domain used to configure the SSL session. </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">session_id</td><td>if supplied, attempt to resume a previous SSL session that used the same session_id. If no previous SSL session is available, a new session will be created using the session_id and stored for future session restore (see ::<a class="el" href="group__ssl.html#ga543c4d6b34f107f41a2812b15e370523">pn_ssl_resume_status</a>). </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">session_id</td><td>if supplied, attempt to resume a previous SSL session that used the same session_id. If no previous SSL session is available, a new session will be created using the session_id and stored for future session restore (see ::<a class="el" href="group__ssl.html#ga5f1a1d6697994bac00edc3df200a8f5f" title="Check whether the state has been resumed. ">pn_ssl_resume_status</a>). </td></tr>
   </table>
   </dd>
 </dl>
@@ -822,12 +884,12 @@ This setting effects only those pn_ssl_t objects created after this call returns
 
 </div>
 </div>
-<a class="anchor" id="ga94467860b566683a4c646487dc537b34"></a>
+<a class="anchor" id="gaec849c8189c12da727e7be7ca757dbdb"></a>
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
-          <td class="memname">PN_EXTERN bool pn_ssl_present </td>
+          <td class="memname">bool pn_ssl_present </td>
           <td>(</td>
           <td class="paramtype">void&#160;</td>
           <td class="paramname"></td><td>)</td>
@@ -835,25 +897,27 @@ This setting effects only those pn_ssl_t objects created after this call returns
         </tr>
       </table>
 </div><div class="memdoc">
-<p>Tests for SSL implementation present</p>
+
+<p>Tests for SSL implementation present. </p>
 <dl class="section return"><dt>Returns</dt><dd>true if we support SSL, false if not </dd></dl>
 
 </div>
 </div>
-<a class="anchor" id="ga543c4d6b34f107f41a2812b15e370523"></a>
+<a class="anchor" id="ga5f1a1d6697994bac00edc3df200a8f5f"></a>
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
-          <td class="memname">PN_EXTERN <a class="el" href="group__ssl.html#gaf175c116d52a91001f9a3559b580f56d">pn_ssl_resume_status_t</a> pn_ssl_resume_status </td>
+          <td class="memname"><a class="el" href="group__ssl.html#gaf175c116d52a91001f9a3559b580f56d">pn_ssl_resume_status_t</a> pn_ssl_resume_status </td>
           <td>(</td>
-          <td class="paramtype">pn_ssl_t *&#160;</td>
+          <td class="paramtype"><a class="el" href="group__ssl.html#ga215da63662423b00d34605ba4f9761f5">pn_ssl_t</a> *&#160;</td>
           <td class="paramname"><em>ssl</em></td><td>)</td>
           <td></td>
         </tr>
       </table>
 </div><div class="memdoc">
-<p>Check whether the state has been resumed.</p>
+
+<p>Check whether the state has been resumed. </p>
 <p>Used for client session resume. When called on an active session, indicates whether the state has been resumed from a previous session.</p>
 <dl class="section note"><dt>Note</dt><dd>This is a best-effort service - there is no guarantee that the remote server will accept the resumed parameters. The remote server may choose to ignore these parameters, and request a re-negotiation instead.</dd></dl>
 <dl class="params"><dt>Parameters</dt><dd>
@@ -866,14 +930,14 @@ This setting effects only those pn_ssl_t objects created after this call returns
 
 </div>
 </div>
-<a class="anchor" id="ga733943a1e722653b5c1f36b7de670ee5"></a>
+<a class="anchor" id="ga15d46dcd823ebd42b9f7f63ed570080a"></a>
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
-          <td class="memname">PN_EXTERN int pn_ssl_set_peer_hostname </td>
+          <td class="memname">int pn_ssl_set_peer_hostname </td>
           <td>(</td>
-          <td class="paramtype">pn_ssl_t *&#160;</td>
+          <td class="paramtype"><a class="el" href="group__ssl.html#ga215da63662423b00d34605ba4f9761f5">pn_ssl_t</a> *&#160;</td>
           <td class="paramname"><em>ssl</em>, </td>
         </tr>
         <tr>
@@ -889,10 +953,11 @@ This setting effects only those pn_ssl_t objects created after this call returns
         </tr>
       </table>
 </div><div class="memdoc">
-<p>Set the expected identity of the remote peer.</p>
-<p>By default, SSL will use the hostname associated with the connection that the transport is bound to (see <a class="el" href="group__connection.html#ga204a7c356658d414f5d08da4f25f5d9e">pn_connection_set_hostname</a>). This method allows the caller to override that default.</p>
+
+<p>Set the expected identity of the remote peer. </p>
+<p>By default, SSL will use the hostname associated with the connection that the transport is bound to (see <a class="el" href="group__connection.html#ga0c3bed8e6764915a137a9daff199ecbb" title="Set the name of the virtual host (either fully qualified or relative) to which this connection is con...">pn_connection_set_hostname</a>). This method allows the caller to override that default.</p>
 <p>The hostname is used for two purposes: 1) when set on an SSL client, it is sent to the server during the handshake (if Server Name Indication is supported), and 2) it is used to check against the identifying name provided in the peer's certificate. If the supplied name does not exactly match a SubjectAltName (type DNS name), or the CommonName entry in the peer's certificate, the peer is considered unauthenticated (potential imposter), and the SSL connection is aborted.</p>
-<dl class="section note"><dt>Note</dt><dd>Verification of the hostname is only done if PN_SSL_VERIFY_PEER_NAME is enabled. See <a class="el" href="group__ssl.html#gacba0321d3d8cd67c601b604a5b42a190">pn_ssl_domain_set_peer_authentication</a>.</dd></dl>
+<dl class="section note"><dt>Note</dt><dd>Verification of the hostname is only done if PN_SSL_VERIFY_PEER_NAME is enabled. See <a class="el" href="group__ssl.html#ga39b67bd22fb8f0a47bcdbdfd40f80b11" title="Configure the level of verification used on the peer certificate. ">pn_ssl_domain_set_peer_authentication</a>.</dd></dl>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramdir">[in]</td><td class="paramname">ssl</td><td>the ssl session. </td></tr>

http://git-wip-us.apache.org/repos/asf/qpid-site/blob/cd4363b2/content/releases/qpid-proton-master/proton/c/api/group__ssl.js
----------------------------------------------------------------------
diff --git a/content/releases/qpid-proton-master/proton/c/api/group__ssl.js b/content/releases/qpid-proton-master/proton/c/api/group__ssl.js
index 62d6147..e4ff994 100755
--- a/content/releases/qpid-proton-master/proton/c/api/group__ssl.js
+++ b/content/releases/qpid-proton-master/proton/c/api/group__ssl.js
@@ -1,5 +1,7 @@
 var group__ssl =
 [
+    [ "pn_ssl_domain_t", "group__ssl.html#gaba83c3a1779c8b35a479bf3a7bb5b175", null ],
+    [ "pn_ssl_t", "group__ssl.html#ga215da63662423b00d34605ba4f9761f5", null ],
     [ "pn_ssl_cert_subject_subfield", "group__ssl.html#ga68d52866e8172acc7ecc7b4fe5b38a40", null ],
     [ "pn_ssl_hash_alg", "group__ssl.html#gaf0b0cd3271ad4a0e33e2a61a8cea7892", null ],
     [ "pn_ssl_mode_t", "group__ssl.html#ga0f1d40875c45b14a31a77f27430bc225", [
@@ -17,22 +19,22 @@ var group__ssl =
       [ "PN_SSL_ANONYMOUS_PEER", "group__ssl.html#ggae5e33024ed6af3432d4c76d1484d7ecbafa6dbe705dd0366ff4799616f788a9f5", null ],
       [ "PN_SSL_VERIFY_PEER_NAME", "group__ssl.html#ggae5e33024ed6af3432d4c76d1484d7ecbaac956f0febf05ab579de839700895e36", null ]
     ] ],
-    [ "pn_ssl", "group__ssl.html#gace9c2c01043714e64fe97a390ffeac87", null ],
-    [ "pn_ssl_domain", "group__ssl.html#gabc9e5e64b23bf03316aa825ba036fb4f", null ],
-    [ "pn_ssl_domain_allow_unsecured_client", "group__ssl.html#ga7bf33cfae6dcd6513da926eff993896d", null ],
-    [ "pn_ssl_domain_free", "group__ssl.html#ga2f0254dda9b35b5af99e744be243daaf", null ],
-    [ "pn_ssl_domain_set_credentials", "group__ssl.html#ga13bc3cf2d0d2f3f612a513752e929251", null ],
-    [ "pn_ssl_domain_set_peer_authentication", "group__ssl.html#gacba0321d3d8cd67c601b604a5b42a190", null ],
-    [ "pn_ssl_domain_set_trusted_ca_db", "group__ssl.html#ga20761fc3f72ab4d947a7c468a43758c9", null ],
-    [ "pn_ssl_get_cert_fingerprint", "group__ssl.html#ga31d1dde4b0fbb1cbc349863013309ba5", null ],
-    [ "pn_ssl_get_cipher_name", "group__ssl.html#ga7ea4334e4925b50cb6c6daa4795cdfa0", null ],
-    [ "pn_ssl_get_peer_hostname", "group__ssl.html#gabc678b1162484ec8eeddba8b594b1f74", null ],
-    [ "pn_ssl_get_protocol_name", "group__ssl.html#ga1636bdfcc884dbae248f0316ae2a076f", null ],
-    [ "pn_ssl_get_remote_subject", "group__ssl.html#ga41e9ea2af96fcbc34fda2e72cff40f2c", null ],
-    [ "pn_ssl_get_remote_subject_subfield", "group__ssl.html#gae6cd9e970301292a1b502a6a1d8bc2ab", null ],
-    [ "pn_ssl_get_ssf", "group__ssl.html#ga4a1837eb135461f71da666f3438c7602", null ],
-    [ "pn_ssl_init", "group__ssl.html#gac5f8d77f86808ae8401691bcd17daa77", null ],
-    [ "pn_ssl_present", "group__ssl.html#ga94467860b566683a4c646487dc537b34", null ],
-    [ "pn_ssl_resume_status", "group__ssl.html#ga543c4d6b34f107f41a2812b15e370523", null ],
-    [ "pn_ssl_set_peer_hostname", "group__ssl.html#ga733943a1e722653b5c1f36b7de670ee5", null ]
+    [ "pn_ssl", "group__ssl.html#gaaeb5284b45f9e2146ff671b1ddc9420c", null ],
+    [ "pn_ssl_domain", "group__ssl.html#gaab5e86b7a4d22943eba82c6e94b82357", null ],
+    [ "pn_ssl_domain_allow_unsecured_client", "group__ssl.html#ga2ac989a62dcd138be770fae0bbb85e74", null ],
+    [ "pn_ssl_domain_free", "group__ssl.html#ga5452ded9c36d78a17c6dea292a01c80d", null ],
+    [ "pn_ssl_domain_set_credentials", "group__ssl.html#ga7311e46bb756474513f3c331e0c1b0aa", null ],
+    [ "pn_ssl_domain_set_peer_authentication", "group__ssl.html#ga39b67bd22fb8f0a47bcdbdfd40f80b11", null ],
+    [ "pn_ssl_domain_set_trusted_ca_db", "group__ssl.html#ga6cdf12ad6ff3d50ac1d31db3cff11c2d", null ],
+    [ "pn_ssl_get_cert_fingerprint", "group__ssl.html#ga324db5da83b1abad2e948481d65119d4", null ],
+    [ "pn_ssl_get_cipher_name", "group__ssl.html#ga47653f84f4b5e3bad46c08d4e82a2c52", null ],
+    [ "pn_ssl_get_peer_hostname", "group__ssl.html#ga76636a5ce4696284356321226ee0731c", null ],
+    [ "pn_ssl_get_protocol_name", "group__ssl.html#ga03e8070271747c3901d8d6e5710c0066", null ],
+    [ "pn_ssl_get_remote_subject", "group__ssl.html#ga11c877302188bc852cfdc9efd6de58c3", null ],
+    [ "pn_ssl_get_remote_subject_subfield", "group__ssl.html#ga0c9e8827536b9929793045771d82bdf1", null ],
+    [ "pn_ssl_get_ssf", "group__ssl.html#ga7fa81d6e5f9b28f90558ab8dd3c4fb1d", null ],
+    [ "pn_ssl_init", "group__ssl.html#ga45f319dd31ad456b8a85927888f94acf", null ],
+    [ "pn_ssl_present", "group__ssl.html#gaec849c8189c12da727e7be7ca757dbdb", null ],
+    [ "pn_ssl_resume_status", "group__ssl.html#ga5f1a1d6697994bac00edc3df200a8f5f", null ],
+    [ "pn_ssl_set_peer_hostname", "group__ssl.html#ga15d46dcd823ebd42b9f7f63ed570080a", null ]
 ];
\ No newline at end of file


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org


Mime
View raw message