You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@qpid.apache.org by jr...@apache.org on 2017/08/30 03:12:44 UTC
[25/51] [partial] qpid-site git commit: QPID-7903: Publish a snapshot
of the Proton C docs
http://git-wip-us.apache.org/repos/asf/qpid-site/blob/36c59045/content/releases/qpid-proton-master/proton/c/api/group__proactor.js
----------------------------------------------------------------------
diff --git a/content/releases/qpid-proton-master/proton/c/api/group__proactor.js b/content/releases/qpid-proton-master/proton/c/api/group__proactor.js
index bef8b32..3c86402 100755
--- a/content/releases/qpid-proton-master/proton/c/api/group__proactor.js
+++ b/content/releases/qpid-proton-master/proton/c/api/group__proactor.js
@@ -1,23 +1,29 @@
var group__proactor =
[
- [ "pn_listener_t", "group__proactor.html#ga68ac7072ae60612d0bca5470014bf216", null ],
- [ "pn_proactor_t", "group__proactor.html#gabba42c7929dfceb9d296535bad0c93dc", null ],
- [ "pn_connection_proactor", "group__proactor.html#ga0daf3895a13049783ab1dc40f3ac46b8", null ],
- [ "pn_connection_wake", "group__proactor.html#ga2e5c9fddae8d7aa07fc93438c5ae2d86", null ],
- [ "pn_event_listener", "group__proactor.html#gad9ea34f659b8bd2d0089fb43fa468300", null ],
- [ "pn_event_proactor", "group__proactor.html#ga01e9b1cf8e0ff18cd4a2d6ed0e73a25a", null ],
- [ "pn_listener", "group__proactor.html#gaaaf34821f3d29274ec41e7ce71022540", null ],
- [ "pn_listener_accept", "group__proactor.html#ga76bcf4efdfa82fff28318e1afad083dc", null ],
- [ "pn_listener_attachments", "group__proactor.html#ga471e37ae503bf6b2635b7f5f5c2d88bf", null ],
- [ "pn_listener_close", "group__proactor.html#ga5690239e2a4f97e3ebbccb25fde75d81", null ],
- [ "pn_listener_condition", "group__proactor.html#ga6dba0fded7ca1718397151c62e65535b", null ],
- [ "pn_listener_proactor", "group__proactor.html#ga491561209bfe8934141015c1dd922a4f", null ],
- [ "pn_proactor", "group__proactor.html#ga9d77772be7805709c87eeb01b06d67e2", null ],
- [ "pn_proactor_connect", "group__proactor.html#ga523ea983380a1566b3b1a7606d66422c", null ],
- [ "pn_proactor_done", "group__proactor.html#gab45680de5c02690a1f1ad1a3c70e9d65", null ],
- [ "pn_proactor_free", "group__proactor.html#ga10fa443c109cee057a3c30e69f93fcef", null ],
- [ "pn_proactor_interrupt", "group__proactor.html#gaff37a5b9d3d822ad9a961dae5155ebdb", null ],
- [ "pn_proactor_listen", "group__proactor.html#ga68300a70c58a825564d5b4ee5d147696", null ],
- [ "pn_proactor_set_timeout", "group__proactor.html#ga8428d00193008841e529aae6a922fa5f", null ],
- [ "pn_proactor_wait", "group__proactor.html#ga56f5830965c20d3dbfc63e795eb243c4", null ]
+ [ "Listener", "group__listener.html", "group__listener" ],
+ [ "Events", "group__proactor__events.html", null ],
+ [ "PN_MAX_ADDR", "group__proactor.html#ga29ae114b42fb797c103dc9883ebcb256", null ],
+ [ "pn_netaddr_t", "group__proactor.html#ga79d820cd3ad391cc5207c83dbb373a9c", null ],
+ [ "pn_netaddr_str", "group__proactor.html#ga9f6a27999303c6082edc581f880de37c", null ],
+ [ "pn_netaddr_local", "group__proactor.html#ga7edab5e295c55e1c2169e39aaa082f8b", null ],
+ [ "pn_netaddr_remote", "group__proactor.html#ga59fa5ba7adc39bc8549645d5d33082c0", null ],
+ [ "pn_netaddr_sockaddr", "group__proactor.html#ga00b1a40af2d837915d21cdb52ccb0c58", null ],
+ [ "pn_netaddr_socklen", "group__proactor.html#gaddaf2b0b3e107d100e4c3658116a6c3c", null ],
+ [ "pn_proactor_addr", "group__proactor.html#gaf67a7642c9003b36255b58776b494c96", null ],
+ [ "pn_proactor", "group__proactor.html#gac2a925b3de00efd8cd40fa9920169554", null ],
+ [ "pn_proactor_free", "group__proactor.html#ga5260c2653d4af5eb2f1c8c6190e9d6cf", null ],
+ [ "pn_proactor_connect", "group__proactor.html#ga9a9d1c4138226fa87160f4769b87f8e6", null ],
+ [ "pn_proactor_listen", "group__proactor.html#gacbed6a4ab75ef8452c10d52e4cd62752", null ],
+ [ "pn_proactor_disconnect", "group__proactor.html#gac600bd88ed0fc6c2b66bed4a8740bd68", null ],
+ [ "pn_proactor_wait", "group__proactor.html#ga2b66a46f3e557010ec61bd105326753d", null ],
+ [ "pn_proactor_get", "group__proactor.html#ga957eae24db6ec4962af79c5a06106115", null ],
+ [ "pn_proactor_done", "group__proactor.html#gade60ff2292b74841766f953b906285c0", null ],
+ [ "pn_proactor_interrupt", "group__proactor.html#gaa5255cd1bcb5d7f5639b53dc30712711", null ],
+ [ "pn_proactor_set_timeout", "group__proactor.html#gad7cd71f06282eb290699d90c316b2d32", null ],
+ [ "pn_proactor_cancel_timeout", "group__proactor.html#gac206e4d0a1b7546d940a83cdd79ce93f", null ],
+ [ "pn_proactor_release_connection", "group__proactor.html#ga1950236260353f82729dbb4589ef6c27", null ],
+ [ "pn_connection_wake", "group__proactor.html#ga0f49c771fe3bff54f58c9d583ca30560", null ],
+ [ "pn_connection_proactor", "group__proactor.html#ga4727a4e26f19efcff0d48960cbba2f40", null ],
+ [ "pn_event_proactor", "group__proactor.html#gac412771217decd84bd70931acbd0828a", null ],
+ [ "pn_proactor_now", "group__proactor.html#gad45b60b98f2bf385ee6ca5dca7b3f42d", null ]
];
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/qpid-site/blob/36c59045/content/releases/qpid-proton-master/proton/c/api/group__proactor__events.html
----------------------------------------------------------------------
diff --git a/content/releases/qpid-proton-master/proton/c/api/group__proactor__events.html b/content/releases/qpid-proton-master/proton/c/api/group__proactor__events.html
new file mode 100755
index 0000000..af179f3
--- /dev/null
+++ b/content/releases/qpid-proton-master/proton/c/api/group__proactor__events.html
@@ -0,0 +1,190 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+<meta http-equiv="X-UA-Compatible" content="IE=9"/>
+<meta name="generator" content="Doxygen 1.8.13"/>
+<meta name="viewport" content="width=device-width, initial-scale=1"/>
+<title>Qpid Proton C API: Events</title>
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="jquery.js"></script>
+<script type="text/javascript" src="dynsections.js"></script>
+<link href="navtree.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="resize.js"></script>
+<script type="text/javascript" src="navtreedata.js"></script>
+<script type="text/javascript" src="navtree.js"></script>
+<script type="text/javascript">
+ $(document).ready(initResizable);
+</script>
+<link href="search/search.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="search/searchdata.js"></script>
+<script type="text/javascript" src="search/search.js"></script>
+<script type="text/javascript">
+ $(document).ready(function() { init_search(); });
+</script>
+<link href="doxygen.css" rel="stylesheet" type="text/css" />
+</head>
+<body>
+<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
+<div id="titlearea">
+<table cellspacing="0" cellpadding="0">
+ <tbody>
+ <tr style="height: 56px;">
+ <td id="projectalign" style="padding-left: 0.5em;">
+ <div id="projectname">Qpid Proton C API
+  <span id="projectnumber">master</span>
+ </div>
+ </td>
+ <td> <div id="MSearchBox" class="MSearchBoxInactive">
+ <span class="left">
+ <img id="MSearchSelect" src="search/mag_sel.png"
+ onmouseover="return searchBox.OnSearchSelectShow()"
+ onmouseout="return searchBox.OnSearchSelectHide()"
+ alt=""/>
+ <input type="text" id="MSearchField" value="Search" accesskey="S"
+ onfocus="searchBox.OnSearchFieldFocus(true)"
+ onblur="searchBox.OnSearchFieldFocus(false)"
+ onkeyup="searchBox.OnSearchFieldChange(event)"/>
+ </span><span class="right">
+ <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
+ </span>
+ </div>
+</td>
+ </tr>
+ </tbody>
+</table>
+</div>
+<!-- end header part -->
+<!-- Generated by Doxygen 1.8.13 -->
+<script type="text/javascript">
+var searchBox = new SearchBox("searchBox", "search",false,'Search');
+</script>
+</div><!-- top -->
+<div id="side-nav" class="ui-resizable side-nav-resizable">
+ <div id="nav-tree">
+ <div id="nav-tree-contents">
+ <div id="nav-sync" class="sync"></div>
+ </div>
+ </div>
+ <div id="splitbar" style="-moz-user-select:none;"
+ class="ui-resizable-handle">
+ </div>
+</div>
+<script type="text/javascript">
+$(document).ready(function(){initNavTree('group__proactor__events.html','');});
+</script>
+<div id="doc-content">
+<!-- window showing the filter options -->
+<div id="MSearchSelectWindow"
+ onmouseover="return searchBox.OnSearchSelectShow()"
+ onmouseout="return searchBox.OnSearchSelectHide()"
+ onkeydown="return searchBox.OnSearchSelectKey(event)">
+</div>
+
+<!-- iframe showing the search results (closed by default) -->
+<div id="MSearchResultsWindow">
+<iframe src="javascript:void(0)" frameborder="0"
+ name="MSearchResults" id="MSearchResults">
+</iframe>
+</div>
+
+<div class="header">
+ <div class="headertitle">
+<div class="title">Events<div class="ingroups"><a class="el" href="group__proactor.html">Proactor</a></div></div> </div>
+</div><!--header-->
+<div class="contents">
+
+<p><b>Experimental</b> - Events returned by <a class="el" href="group__proactor.html#ga2b66a46f3e557010ec61bd105326753d" title="Wait until there are Events to handle. ">pn_proactor_wait()</a>.
+<a href="#details">More...</a></p>
+<p><b>Experimental</b> - Events returned by <a class="el" href="group__proactor.html#ga2b66a46f3e557010ec61bd105326753d" title="Wait until there are Events to handle. ">pn_proactor_wait()</a>. </p>
+<p><a class="el" href="group__proactor.html#ga2b66a46f3e557010ec61bd105326753d" title="Wait until there are Events to handle. ">pn_proactor_wait()</a> returns a subset of the event types defined by <a class="el" href="group__event.html#ga4876e2eed24a4d4e4c52b99842103cda">pn_event_type_t</a>. The PN_REACTOR_..., PN_SELECTABLE_... and PN_..._FINAL events are not returned.</p>
+<table class="doxtable">
+<tr>
+<th align="left">Enumeration </th><th align="left">Brief description, see <a class="el" href="group__event.html#ga4876e2eed24a4d4e4c52b99842103cda">pn_event_type_t</a> for more </th></tr>
+<tr>
+<td align="left"><a class="el" href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaa182e571a0310028514bce66a41063a6e">PN_CONNECTION_INIT</a> </td><td align="left">The connection has been created. </td></tr>
+<tr>
+<td align="left"><a class="el" href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaaf61aa79ca82b3a8f5017dc735843fae5">PN_CONNECTION_BOUND</a> </td><td align="left">The connection has been bound to a transport. </td></tr>
+<tr>
+<td align="left"><a class="el" href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaa13fdcb0402f982fd366e58f165f376c9">PN_TIMER_TASK</a> </td><td align="left">A timer event has occurred. </td></tr>
+<tr>
+<td align="left"><a class="el" href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaa182e571a0310028514bce66a41063a6e">PN_CONNECTION_INIT</a> </td><td align="left">The connection has been created. </td></tr>
+<tr>
+<td align="left"><a class="el" href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaaf61aa79ca82b3a8f5017dc735843fae5">PN_CONNECTION_BOUND</a> </td><td align="left">The connection has been bound to a transport. </td></tr>
+<tr>
+<td align="left"><a class="el" href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaac683ba544c12cbf36a3d3015ae818498">PN_CONNECTION_UNBOUND</a> </td><td align="left">The connection has been unbound from its transport. </td></tr>
+<tr>
+<td align="left"><a class="el" href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaa5d285c46982df224c3e4733b05c3540a">PN_CONNECTION_LOCAL_OPEN</a> </td><td align="left">The local connection endpoint has been closed. </td></tr>
+<tr>
+<td align="left"><a class="el" href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaad48bce685db553740fa71cc36473b5cc">PN_CONNECTION_REMOTE_OPEN</a> </td><td align="left">The remote endpoint has opened the connection. </td></tr>
+<tr>
+<td align="left"><a class="el" href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaac8567664d41057ae94d23776f5ecdb86">PN_CONNECTION_LOCAL_CLOSE</a> </td><td align="left">The local connection endpoint has been closed. </td></tr>
+<tr>
+<td align="left"><a class="el" href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaa1252529cf9f03d214c9b4fea5cf11b2f">PN_CONNECTION_REMOTE_CLOSE</a> </td><td align="left">The remote endpoint has closed the connection. </td></tr>
+<tr>
+<td align="left"><a class="el" href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaaf5b92fb6331bfe63786db3950073147f">PN_SESSION_INIT</a> </td><td align="left">The session has been created. </td></tr>
+<tr>
+<td align="left"><a class="el" href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaa0862b8e3613b7a2b5a08a779474df424">PN_SESSION_LOCAL_OPEN</a> </td><td align="left">The local session endpoint has been opened. </td></tr>
+<tr>
+<td align="left"><a class="el" href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaaf67df046bea45df34aea863d9541e806">PN_SESSION_REMOTE_OPEN</a> </td><td align="left">The remote endpoint has opened the session. </td></tr>
+<tr>
+<td align="left"><a class="el" href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaa5d3fe92cc7ef0e8712b038ecfbd05029">PN_SESSION_LOCAL_CLOSE</a> </td><td align="left">The local session endpoint has been closed. </td></tr>
+<tr>
+<td align="left"><a class="el" href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaa3410075b825c59b8f4efdcddf5a5b135">PN_SESSION_REMOTE_CLOSE</a> </td><td align="left">The remote endpoint has closed the session. </td></tr>
+<tr>
+<td align="left"><a class="el" href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaa2f9e46bded95d0233cc74a71fdc75a2c">PN_LINK_INIT</a> </td><td align="left">The link has been created. </td></tr>
+<tr>
+<td align="left"><a class="el" href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaa5ddecd4b0ea72895413fbf1b5cb41f65">PN_LINK_LOCAL_OPEN</a> </td><td align="left">The local link endpoint has been opened. </td></tr>
+<tr>
+<td align="left"><a class="el" href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaa45edb44a6cc7908b5032944e08925307">PN_LINK_REMOTE_OPEN</a> </td><td align="left">The remote endpoint has opened the link. </td></tr>
+<tr>
+<td align="left"><a class="el" href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaa3b27f8d1c91cc05b47bed1905d42373a">PN_LINK_LOCAL_CLOSE</a> </td><td align="left">The local link endpoint has been closed. </td></tr>
+<tr>
+<td align="left"><a class="el" href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaa1153f0108be071c31210dd1cd3e40a1f">PN_LINK_REMOTE_CLOSE</a> </td><td align="left">The remote endpoint has closed the link. </td></tr>
+<tr>
+<td align="left"><a class="el" href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaa838b909cce908f5769d043ba3e73e73e">PN_LINK_LOCAL_DETACH</a> </td><td align="left">The local link endpoint has been detached. </td></tr>
+<tr>
+<td align="left"><a class="el" href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaa5a84b68a2bd5ca705187381a785121d2">PN_LINK_REMOTE_DETACH</a> </td><td align="left">The remote endpoint has detached the link. </td></tr>
+<tr>
+<td align="left"><a class="el" href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaa4eaecc54c07cdc9b0df7b1d536a7dc3f">PN_LINK_FLOW</a> </td><td align="left">The flow control state for a link has changed. </td></tr>
+<tr>
+<td align="left"><a class="el" href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaa70bbfc163d85732b5652dc70fb3330fe">PN_DELIVERY</a> </td><td align="left">A delivery has been created or updated. </td></tr>
+<tr>
+<td align="left"><a class="el" href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaad7329eb7a015f62ce70719ea20abab76">PN_TRANSPORT</a> </td><td align="left">The transport has new data to read and/or write. </td></tr>
+<tr>
+<td align="left"><a class="el" href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaaa205271edd307e5d33bd8287a760ad28">PN_TRANSPORT_AUTHENTICATED</a> </td><td align="left">The transport has authenticated. </td></tr>
+<tr>
+<td align="left"><a class="el" href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaa7c7278de5bcbf3b42b3e692ca21f6c5a">PN_TRANSPORT_ERROR</a> </td><td align="left">Indicates that a transport error has occurred. </td></tr>
+<tr>
+<td align="left"><a class="el" href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaa98facd13835b4a1d8e878d6f13c10a51">PN_TRANSPORT_HEAD_CLOSED</a> </td><td align="left">Indicates that the "head" or writing end of the transport has been closed. </td></tr>
+<tr>
+<td align="left"><a class="el" href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaa205d07df6cd3d07b37a89f046b1184db">PN_TRANSPORT_TAIL_CLOSED</a> </td><td align="left">Indicates that the tail of the transport has been closed. </td></tr>
+<tr>
+<td align="left"><a class="el" href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaa1ca722ce3c0b2c13a33636cded8430ba">PN_TRANSPORT_CLOSED</a> </td><td align="left">The final event for a proactor connection, the transport is closed. </td></tr>
+<tr>
+<td align="left"><a class="el" href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaa6e25f00110ab278fd8b34fee00bd5fd7">PN_LISTENER_OPEN</a> </td><td align="left">The listener is listeneing. </td></tr>
+<tr>
+<td align="left"><a class="el" href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaa0602b15957883e7d00ccdff4abca992c">PN_LISTENER_ACCEPT</a> </td><td align="left">Indicates the listener has an incoming connection, call <a class="el" href="group__listener.html#gaaee3c3f3822484bc2e370406abf5b736" title="Bind connection to a new transport accepted from listener. ">pn_listener_accept()</a> to accept it. </td></tr>
+<tr>
+<td align="left"><a class="el" href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaad5920df168cd28daaf253cad789d8aca">PN_LISTENER_CLOSE</a> </td><td align="left">Indicates the listener has closed. </td></tr>
+<tr>
+<td align="left"><a class="el" href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaaee05826a80e94b5b86c4544e4715f499">PN_PROACTOR_INTERRUPT</a> </td><td align="left">Indicates <a class="el" href="group__proactor.html#gaa5255cd1bcb5d7f5639b53dc30712711" title="Return a PN_PROACTOR_INTERRUPT event as soon as possible. ">pn_proactor_interrupt()</a> was called to interrupt a proactor thread. </td></tr>
+<tr>
+<td align="left"><a class="el" href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaa4afa8c2da61f4c665c669fbe37b1c5fe">PN_PROACTOR_TIMEOUT</a> </td><td align="left">Timeout set by <a class="el" href="group__proactor.html#gad7cd71f06282eb290699d90c316b2d32" title="Return a PN_PROACTOR_TIMEOUT after timeout milliseconds elapse. ">pn_proactor_set_timeout()</a> time limit expired. </td></tr>
+<tr>
+<td align="left"><a class="el" href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaa894e93f167ef39e28a07c9cdf6b1181b">PN_PROACTOR_INACTIVE</a> </td><td align="left">The proactor has become inactive: all listeners and connections were closed and the timeout (if set) expired or was cancelled. </td></tr>
+<tr>
+<td align="left"><a class="el" href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaa28a2bfee806bbc1fe31499c8eec39db0">PN_CONNECTION_WAKE</a> </td><td align="left"><a class="el" href="group__proactor.html#ga0f49c771fe3bff54f58c9d583ca30560" title="Return a PN_CONNECTION_WAKE event for connection as soon as possible. ">pn_connection_wake()</a> was called. </td></tr>
+</table>
+</div><!-- contents -->
+</div><!-- doc-content -->
+<!-- start footer part -->
+<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
+ <ul>
+ <li class="footer">Generated by
+ <a href="http://www.doxygen.org/index.html">
+ <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
+ </ul>
+</div>
+</body>
+</html>
http://git-wip-us.apache.org/repos/asf/qpid-site/blob/36c59045/content/releases/qpid-proton-master/proton/c/api/group__sasl.html
----------------------------------------------------------------------
diff --git a/content/releases/qpid-proton-master/proton/c/api/group__sasl.html b/content/releases/qpid-proton-master/proton/c/api/group__sasl.html
index 5034769..09002d6 100755
--- a/content/releases/qpid-proton-master/proton/c/api/group__sasl.html
+++ b/content/releases/qpid-proton-master/proton/c/api/group__sasl.html
@@ -3,7 +3,8 @@
<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.11"/>
+<meta name="generator" content="Doxygen 1.8.13"/>
+<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Qpid Proton C API: SASL</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
@@ -14,7 +15,6 @@
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
- $(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
@@ -55,7 +55,7 @@
</table>
</div>
<!-- end header part -->
-<!-- Generated by Doxygen 1.8.11 -->
+<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
@@ -161,7 +161,9 @@ Functions</h2></td></tr>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>SASL secure transport layer. </p>
<h2 class="groupheader">Typedef Documentation</h2>
-<a class="anchor" id="ga4d21fddba80d3f88d0529aafe12328b0"></a>
+<a id="ga4d21fddba80d3f88d0529aafe12328b0"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ga4d21fddba80d3f88d0529aafe12328b0">◆ </a></span>pn_sasl_t</h2>
+
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -177,7 +179,9 @@ Functions</h2></td></tr>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
-<a class="anchor" id="gad44e79f52e0669b1930689b56dfa9c3b"></a>
+<a id="gad44e79f52e0669b1930689b56dfa9c3b"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#gad44e79f52e0669b1930689b56dfa9c3b">◆ </a></span>pn_sasl_outcome_t</h2>
+
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -189,27 +193,24 @@ Functions</h2></td></tr>
<p>The result of the SASL negotiation. </p>
<table class="fieldtable">
-<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="ggad44e79f52e0669b1930689b56dfa9c3ba0050b91650a3826a090e13f57b3b941e"></a>PN_SASL_OK </td><td class="fielddoc">
-<p>negotiation not completed </p>
+<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggad44e79f52e0669b1930689b56dfa9c3ba0050b91650a3826a090e13f57b3b941e"></a>PN_SASL_OK </td><td class="fielddoc"><p>negotiation not completed </p>
</td></tr>
-<tr><td class="fieldname"><a class="anchor" id="ggad44e79f52e0669b1930689b56dfa9c3bac63734ecde7c8170554f6bf04f6ce64a"></a>PN_SASL_AUTH </td><td class="fielddoc">
-<p>authentication succeeded </p>
+<tr><td class="fieldname"><a id="ggad44e79f52e0669b1930689b56dfa9c3bac63734ecde7c8170554f6bf04f6ce64a"></a>PN_SASL_AUTH </td><td class="fielddoc"><p>authentication succeeded </p>
</td></tr>
-<tr><td class="fieldname"><a class="anchor" id="ggad44e79f52e0669b1930689b56dfa9c3bacd46a2fda23f674c23ed81e6076c1939"></a>PN_SASL_SYS </td><td class="fielddoc">
-<p>failed due to bad credentials </p>
+<tr><td class="fieldname"><a id="ggad44e79f52e0669b1930689b56dfa9c3bacd46a2fda23f674c23ed81e6076c1939"></a>PN_SASL_SYS </td><td class="fielddoc"><p>failed due to bad credentials </p>
</td></tr>
-<tr><td class="fieldname"><a class="anchor" id="ggad44e79f52e0669b1930689b56dfa9c3ba03019f909ba1d98aae94437ca4bd0191"></a>PN_SASL_PERM </td><td class="fielddoc">
-<p>failed due to a system error </p>
+<tr><td class="fieldname"><a id="ggad44e79f52e0669b1930689b56dfa9c3ba03019f909ba1d98aae94437ca4bd0191"></a>PN_SASL_PERM </td><td class="fielddoc"><p>failed due to a system error </p>
</td></tr>
-<tr><td class="fieldname"><a class="anchor" id="ggad44e79f52e0669b1930689b56dfa9c3baee28d2c03fa80dccf771e37aae1bcdf3"></a>PN_SASL_TEMP </td><td class="fielddoc">
-<p>failed due to unrecoverable error </p>
+<tr><td class="fieldname"><a id="ggad44e79f52e0669b1930689b56dfa9c3baee28d2c03fa80dccf771e37aae1bcdf3"></a>PN_SASL_TEMP </td><td class="fielddoc"><p>failed due to unrecoverable error </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
-<a class="anchor" id="ga7968e80e2fe9360fc14cf865dd1ac21c"></a>
+<a id="ga7968e80e2fe9360fc14cf865dd1ac21c"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ga7968e80e2fe9360fc14cf865dd1ac21c">◆ </a></span>pn_sasl()</h2>
+
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -227,53 +228,41 @@ Functions</h2></td></tr>
<p>This will return the SASL layer object for the supplied transport object. If there is currently no SASL layer one will be created.</p>
<p>On the client side of an AMQP connection this will have the effect of ensuring that the AMQP SASL layer is used for that connection.</p>
<dl class="section return"><dt>Returns</dt><dd>an object representing the SASL layer. </dd></dl>
-<dl><dt><b>Examples: </b></dt><dd><a class="el" href="broker_8c-example.html#a38">broker.c</a>.</dd>
+<dl><dt><b>Examples: </b></dt><dd><a class="el" href="broker_8c-example.html#a37">broker.c</a>, and <a class="el" href="direct_8c-example.html#a68">direct.c</a>.</dd>
</dl>
</div>
</div>
-<a class="anchor" id="ga73299a6a22e141e7911a739590032625"></a>
+<a id="ga1737191972d5dded0993bf1431e71df0"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ga1737191972d5dded0993bf1431e71df0">◆ </a></span>pn_sasl_extended()</h2>
+
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname">void pn_sasl_allowed_mechs </td>
+ <td class="memname">bool pn_sasl_extended </td>
<td>(</td>
- <td class="paramtype"><a class="el" href="group__sasl.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> * </td>
- <td class="paramname"><em>sasl</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>mechs</em> </td>
- </tr>
- <tr>
+ <td class="paramtype">void </td>
+ <td class="paramname"></td><td>)</td>
<td></td>
- <td>)</td>
- <td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
-<p>SASL mechanisms that are to be considered for authentication. </p>
-<p>This can be used on either the client or the server to restrict the SASL mechanisms that may be used to the mechanisms on the list.</p>
-<dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">sasl</td><td>the SASL layer </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">mechs</td><td>space separated list of mechanisms that are allowed for authentication </td></tr>
- </table>
- </dd>
-</dl>
-<dl><dt><b>Examples: </b></dt><dd><a class="el" href="broker_8c-example.html#a37">broker.c</a>.</dd>
-</dl>
+<p>Do we support extended SASL negotiation. </p>
+<p>Do we support extended SASL negotiation? All implementations of Proton support ANONYMOUS and EXTERNAL on both client and server sides and PLAIN on the client side.</p>
+<p>Extended SASL implememtations use an external library (Cyrus SASL) to support other mechanisms beyond these basic ones.</p>
+<dl class="section return"><dt>Returns</dt><dd>true if we support extended SASL negotiation, false if we only support basic negotiation. </dd></dl>
+
</div>
</div>
-<a class="anchor" id="gad1a6932135165f0e5b7639b79ac71c56"></a>
+<a id="ga0199871440c4ff89a204cc1d8a09f283"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ga0199871440c4ff89a204cc1d8a09f283">◆ </a></span>pn_sasl_done()</h2>
+
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname">void pn_sasl_config_name </td>
+ <td class="memname">void pn_sasl_done </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__sasl.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> * </td>
<td class="paramname"><em>sasl</em>, </td>
@@ -281,8 +270,8 @@ Functions</h2></td></tr>
<tr>
<td class="paramkey"></td>
<td></td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>name</em> </td>
+ <td class="paramtype"><a class="el" href="group__sasl.html#gad44e79f52e0669b1930689b56dfa9c3b">pn_sasl_outcome_t</a> </td>
+ <td class="paramname"><em>outcome</em> </td>
</tr>
<tr>
<td></td>
@@ -292,163 +281,175 @@ Functions</h2></td></tr>
</table>
</div><div class="memdoc">
-<p>Set the sasl configuration name. </p>
-<p>This is used to construct the SASL configuration filename. In the current implementation it ".conf" is added to the name and the file is looked for in the configuration directory.</p>
-<p>If not set it will default to "proton-server" for a sasl server and "proton-client" for a client.</p>
-<dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">sasl</td><td>the SASL layer </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>the configuration name </td></tr>
- </table>
- </dd>
-</dl>
+<p>Set the outcome of SASL negotiation. </p>
+<p>Used by the server to set the result of the negotiation process.</p>
</div>
</div>
-<a class="anchor" id="gabf4176414424ce02a4e03b4338d30521"></a>
+<a id="ga03b6daf742db6a07bd7d03cb197aedb6"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ga03b6daf742db6a07bd7d03cb197aedb6">◆ </a></span>pn_sasl_outcome()</h2>
+
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname">void pn_sasl_config_path </td>
+ <td class="memname"><a class="el" href="group__sasl.html#gad44e79f52e0669b1930689b56dfa9c3b">pn_sasl_outcome_t</a> pn_sasl_outcome </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__sasl.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> * </td>
- <td class="paramname"><em>sasl</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>path</em> </td>
- </tr>
- <tr>
+ <td class="paramname"><em>sasl</em></td><td>)</td>
<td></td>
- <td>)</td>
- <td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
-<p>Set the sasl configuration path. </p>
-<p>This is used to tell SASL where to look for the configuration file. In the current implementation it can be a colon separated list of directories.</p>
-<p>The environment variable PN_SASL_CONFIG_PATH can also be used to set this path, but if both methods are used then this <a class="el" href="group__sasl.html#gabf4176414424ce02a4e03b4338d30521" title="Set the sasl configuration path. ">pn_sasl_config_path()</a> will take precedence.</p>
-<p>If not set the underlying implementation default will be used. for a client.</p>
-<dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">sasl</td><td>the SASL layer </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>the configuration path </td></tr>
- </table>
- </dd>
-</dl>
+<p>Retrieve the outcome of SASL negotiation. </p>
</div>
</div>
-<a class="anchor" id="ga0199871440c4ff89a204cc1d8a09f283"></a>
+<a id="ga700e1d505068f895383dd932af55987e"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ga700e1d505068f895383dd932af55987e">◆ </a></span>pn_sasl_get_user()</h2>
+
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname">void pn_sasl_done </td>
+ <td class="memname">const char* pn_sasl_get_user </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__sasl.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> * </td>
- <td class="paramname"><em>sasl</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="group__sasl.html#gad44e79f52e0669b1930689b56dfa9c3b">pn_sasl_outcome_t</a> </td>
- <td class="paramname"><em>outcome</em> </td>
- </tr>
- <tr>
+ <td class="paramname"><em>sasl</em></td><td>)</td>
<td></td>
- <td>)</td>
- <td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
-<p>Set the outcome of SASL negotiation. </p>
-<p>Used by the server to set the result of the negotiation process.</p>
+<p>Retrieve the authenticated user. </p>
+<p>This is usually used at the the server end to find the name of the authenticated user. On the client it will merely return whatever user was passed in to the pn_transport_set_user_password() API.</p>
+<p>If <a class="el" href="group__sasl.html#ga03b6daf742db6a07bd7d03cb197aedb6" title="Retrieve the outcome of SASL negotiation. ">pn_sasl_outcome()</a> returns a value other than PN_SASL_OK, then there will be no user to return. The returned value is only reliable after the PN_TRANSPORT_AUTHENTICATED event has been received.</p>
+<dl class="params"><dt>Parameters</dt><dd>
+ <table class="params">
+ <tr><td class="paramdir">[in]</td><td class="paramname">sasl</td><td>the sasl layer</td></tr>
+ </table>
+ </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>If the SASL layer was not negotiated then 0 is returned If the ANONYMOUS mechanism is used then the user will be "anonymous" Otherwise a string containing the user is returned. </dd></dl>
</div>
</div>
-<a class="anchor" id="ga1737191972d5dded0993bf1431e71df0"></a>
+<a id="ga895b6a957bf0c0204aaddb3ec5b9d863"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ga895b6a957bf0c0204aaddb3ec5b9d863">◆ </a></span>pn_sasl_get_mech()</h2>
+
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname">bool pn_sasl_extended </td>
+ <td class="memname">const char* pn_sasl_get_mech </td>
<td>(</td>
- <td class="paramtype">void </td>
- <td class="paramname"></td><td>)</td>
+ <td class="paramtype"><a class="el" href="group__sasl.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> * </td>
+ <td class="paramname"><em>sasl</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
-<p>Do we support extended SASL negotiation. </p>
-<p>Do we support extended SASL negotiation? All implementations of Proton support ANONYMOUS and EXTERNAL on both client and server sides and PLAIN on the client side.</p>
-<p>Extended SASL implememtations use an external library (Cyrus SASL) to support other mechanisms beyond these basic ones.</p>
-<dl class="section return"><dt>Returns</dt><dd>true if we support extended SASL negotiation, false if we only support basic negotiation. </dd></dl>
+<p>Return the selected SASL mechanism. </p>
+<p>The returned value is only reliable after the PN_TRANSPORT_AUTHENTICATED event has been received.</p>
+<dl class="params"><dt>Parameters</dt><dd>
+ <table class="params">
+ <tr><td class="paramdir">[in]</td><td class="paramname">sasl</td><td>the SASL layer</td></tr>
+ </table>
+ </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>The authentication mechanism selected by the SASL layer </dd></dl>
</div>
</div>
-<a class="anchor" id="gac53ad15ee429b7ce9d0c598d1e347243"></a>
+<a id="ga73299a6a22e141e7911a739590032625"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ga73299a6a22e141e7911a739590032625">◆ </a></span>pn_sasl_allowed_mechs()</h2>
+
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname">bool pn_sasl_get_allow_insecure_mechs </td>
+ <td class="memname">void pn_sasl_allowed_mechs </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__sasl.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> * </td>
- <td class="paramname"><em>sasl</em></td><td>)</td>
+ <td class="paramname"><em>sasl</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
<td></td>
+ <td class="paramtype">const char * </td>
+ <td class="paramname"><em>mechs</em> </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
-<p>Return the current value for allow_insecure_mechs. </p>
+<p>SASL mechanisms that are to be considered for authentication. </p>
+<p>This can be used on either the client or the server to restrict the SASL mechanisms that may be used to the mechanisms on the list.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">sasl</td><td>the SASL layer </td></tr>
+ <tr><td class="paramdir">[in]</td><td class="paramname">mechs</td><td>space separated list of mechanisms that are allowed for authentication </td></tr>
</table>
</dd>
</dl>
-
+<dl><dt><b>Examples: </b></dt><dd><a class="el" href="broker_8c-example.html#a36">broker.c</a>, and <a class="el" href="direct_8c-example.html#a67">direct.c</a>.</dd>
+</dl>
</div>
</div>
-<a class="anchor" id="ga895b6a957bf0c0204aaddb3ec5b9d863"></a>
+<a id="gaf472325bc055bb18a5a6f5ca03eda315"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#gaf472325bc055bb18a5a6f5ca03eda315">◆ </a></span>pn_sasl_set_allow_insecure_mechs()</h2>
+
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname">const char* pn_sasl_get_mech </td>
+ <td class="memname">void pn_sasl_set_allow_insecure_mechs </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__sasl.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> * </td>
- <td class="paramname"><em>sasl</em></td><td>)</td>
+ <td class="paramname"><em>sasl</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
<td></td>
+ <td class="paramtype">bool </td>
+ <td class="paramname"><em>insecure</em> </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
-<p>Return the selected SASL mechanism. </p>
-<p>The returned value is only reliable after the PN_TRANSPORT_AUTHENTICATED event has been received.</p>
+<p>Boolean to allow use of clear text authentication mechanisms. </p>
+<p>By default the SASL layer is configured not to allow mechanisms that disclose the clear text of the password over an unencrypted AMQP connection. This specifically will disallow the use of the PLAIN mechanism without using SSL encryption.</p>
+<p>This default is to avoid disclosing password information accidentally over an insecure network.</p>
+<p>If you actually wish to use a clear text password unencrypted then you can use this API to set allow_insecure_mechs to true.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">sasl</td><td>the SASL layer</td></tr>
+ <tr><td class="paramdir">[in]</td><td class="paramname">sasl</td><td>the SASL layer </td></tr>
+ <tr><td class="paramdir">[in]</td><td class="paramname">insecure</td><td>set this to true to allow unencrypted PLAIN authentication. </td></tr>
</table>
</dd>
</dl>
-<dl class="section return"><dt>Returns</dt><dd>The authentication mechanism selected by the SASL layer </dd></dl>
</div>
</div>
-<a class="anchor" id="ga700e1d505068f895383dd932af55987e"></a>
+<a id="gac53ad15ee429b7ce9d0c598d1e347243"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#gac53ad15ee429b7ce9d0c598d1e347243">◆ </a></span>pn_sasl_get_allow_insecure_mechs()</h2>
+
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname">const char* pn_sasl_get_user </td>
+ <td class="memname">bool pn_sasl_get_allow_insecure_mechs </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__sasl.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> * </td>
<td class="paramname"><em>sasl</em></td><td>)</td>
@@ -457,43 +458,63 @@ Functions</h2></td></tr>
</table>
</div><div class="memdoc">
-<p>Retrieve the authenticated user. </p>
-<p>This is usually used at the the server end to find the name of the authenticated user. On the client it will merely return whatever user was passed in to the pn_transport_set_user_password() API.</p>
-<p>If <a class="el" href="group__sasl.html#ga03b6daf742db6a07bd7d03cb197aedb6" title="Retrieve the outcome of SASL negotiation. ">pn_sasl_outcome()</a> returns a value other than PN_SASL_OK, then there will be no user to return. The returned value is only reliable after the PN_TRANSPORT_AUTHENTICATED event has been received.</p>
+<p>Return the current value for allow_insecure_mechs. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">sasl</td><td>the sasl layer</td></tr>
+ <tr><td class="paramdir">[in]</td><td class="paramname">sasl</td><td>the SASL layer </td></tr>
</table>
</dd>
</dl>
-<dl class="section return"><dt>Returns</dt><dd>If the SASL layer was not negotiated then 0 is returned If the ANONYMOUS mechanism is used then the user will be "anonymous" Otherwise a string containing the user is returned. </dd></dl>
</div>
</div>
-<a class="anchor" id="ga03b6daf742db6a07bd7d03cb197aedb6"></a>
+<a id="gad1a6932135165f0e5b7639b79ac71c56"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#gad1a6932135165f0e5b7639b79ac71c56">◆ </a></span>pn_sasl_config_name()</h2>
+
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname"><a class="el" href="group__sasl.html#gad44e79f52e0669b1930689b56dfa9c3b">pn_sasl_outcome_t</a> pn_sasl_outcome </td>
+ <td class="memname">void pn_sasl_config_name </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__sasl.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> * </td>
- <td class="paramname"><em>sasl</em></td><td>)</td>
+ <td class="paramname"><em>sasl</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
<td></td>
+ <td class="paramtype">const char * </td>
+ <td class="paramname"><em>name</em> </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
-<p>Retrieve the outcome of SASL negotiation. </p>
+<p>Set the sasl configuration name. </p>
+<p>This is used to construct the SASL configuration filename. In the current implementation it ".conf" is added to the name and the file is looked for in the configuration directory.</p>
+<p>If not set it will default to "proton-server" for a sasl server and "proton-client" for a client.</p>
+<dl class="params"><dt>Parameters</dt><dd>
+ <table class="params">
+ <tr><td class="paramdir">[in]</td><td class="paramname">sasl</td><td>the SASL layer </td></tr>
+ <tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>the configuration name </td></tr>
+ </table>
+ </dd>
+</dl>
</div>
</div>
-<a class="anchor" id="gaf472325bc055bb18a5a6f5ca03eda315"></a>
+<a id="gabf4176414424ce02a4e03b4338d30521"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#gabf4176414424ce02a4e03b4338d30521">◆ </a></span>pn_sasl_config_path()</h2>
+
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname">void pn_sasl_set_allow_insecure_mechs </td>
+ <td class="memname">void pn_sasl_config_path </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__sasl.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> * </td>
<td class="paramname"><em>sasl</em>, </td>
@@ -501,8 +522,8 @@ Functions</h2></td></tr>
<tr>
<td class="paramkey"></td>
<td></td>
- <td class="paramtype">bool </td>
- <td class="paramname"><em>insecure</em> </td>
+ <td class="paramtype">const char * </td>
+ <td class="paramname"><em>path</em> </td>
</tr>
<tr>
<td></td>
@@ -512,14 +533,14 @@ Functions</h2></td></tr>
</table>
</div><div class="memdoc">
-<p>Boolean to allow use of clear text authentication mechanisms. </p>
-<p>By default the SASL layer is configured not to allow mechanisms that disclose the clear text of the password over an unencrypted AMQP connection. This specifically will disallow the use of the PLAIN mechanism without using SSL encryption.</p>
-<p>This default is to avoid disclosing password information accidentally over an insecure network.</p>
-<p>If you actually wish to use a clear text password unencrypted then you can use this API to set allow_insecure_mechs to true.</p>
+<p>Set the sasl configuration path. </p>
+<p>This is used to tell SASL where to look for the configuration file. In the current implementation it can be a colon separated list of directories.</p>
+<p>The environment variable PN_SASL_CONFIG_PATH can also be used to set this path, but if both methods are used then this <a class="el" href="group__sasl.html#gabf4176414424ce02a4e03b4338d30521" title="Set the sasl configuration path. ">pn_sasl_config_path()</a> will take precedence.</p>
+<p>If not set the underlying implementation default will be used. for a client.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">sasl</td><td>the SASL layer </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">insecure</td><td>set this to true to allow unencrypted PLAIN authentication. </td></tr>
+ <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>the configuration path </td></tr>
</table>
</dd>
</dl>
@@ -533,7 +554,7 @@ Functions</h2></td></tr>
<ul>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
- <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
+ <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>
</div>
</body>
http://git-wip-us.apache.org/repos/asf/qpid-site/blob/36c59045/content/releases/qpid-proton-master/proton/c/api/group__sasl.js
----------------------------------------------------------------------
diff --git a/content/releases/qpid-proton-master/proton/c/api/group__sasl.js b/content/releases/qpid-proton-master/proton/c/api/group__sasl.js
index ac06fa9..0e97078 100755
--- a/content/releases/qpid-proton-master/proton/c/api/group__sasl.js
+++ b/content/releases/qpid-proton-master/proton/c/api/group__sasl.js
@@ -9,14 +9,14 @@ var group__sasl =
[ "PN_SASL_TEMP", "group__sasl.html#ggad44e79f52e0669b1930689b56dfa9c3baee28d2c03fa80dccf771e37aae1bcdf3", null ]
] ],
[ "pn_sasl", "group__sasl.html#ga7968e80e2fe9360fc14cf865dd1ac21c", null ],
- [ "pn_sasl_allowed_mechs", "group__sasl.html#ga73299a6a22e141e7911a739590032625", null ],
- [ "pn_sasl_config_name", "group__sasl.html#gad1a6932135165f0e5b7639b79ac71c56", null ],
- [ "pn_sasl_config_path", "group__sasl.html#gabf4176414424ce02a4e03b4338d30521", null ],
- [ "pn_sasl_done", "group__sasl.html#ga0199871440c4ff89a204cc1d8a09f283", null ],
[ "pn_sasl_extended", "group__sasl.html#ga1737191972d5dded0993bf1431e71df0", null ],
- [ "pn_sasl_get_allow_insecure_mechs", "group__sasl.html#gac53ad15ee429b7ce9d0c598d1e347243", null ],
- [ "pn_sasl_get_mech", "group__sasl.html#ga895b6a957bf0c0204aaddb3ec5b9d863", null ],
- [ "pn_sasl_get_user", "group__sasl.html#ga700e1d505068f895383dd932af55987e", null ],
+ [ "pn_sasl_done", "group__sasl.html#ga0199871440c4ff89a204cc1d8a09f283", null ],
[ "pn_sasl_outcome", "group__sasl.html#ga03b6daf742db6a07bd7d03cb197aedb6", null ],
- [ "pn_sasl_set_allow_insecure_mechs", "group__sasl.html#gaf472325bc055bb18a5a6f5ca03eda315", null ]
+ [ "pn_sasl_get_user", "group__sasl.html#ga700e1d505068f895383dd932af55987e", null ],
+ [ "pn_sasl_get_mech", "group__sasl.html#ga895b6a957bf0c0204aaddb3ec5b9d863", null ],
+ [ "pn_sasl_allowed_mechs", "group__sasl.html#ga73299a6a22e141e7911a739590032625", null ],
+ [ "pn_sasl_set_allow_insecure_mechs", "group__sasl.html#gaf472325bc055bb18a5a6f5ca03eda315", null ],
+ [ "pn_sasl_get_allow_insecure_mechs", "group__sasl.html#gac53ad15ee429b7ce9d0c598d1e347243", null ],
+ [ "pn_sasl_config_name", "group__sasl.html#gad1a6932135165f0e5b7639b79ac71c56", null ],
+ [ "pn_sasl_config_path", "group__sasl.html#gabf4176414424ce02a4e03b4338d30521", 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