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/09/12 23:38:08 UTC
[44/51] [partial] qpid-site git commit: QPID-7903: Refresh the Proton
C docs snaphot once again
http://git-wip-us.apache.org/repos/asf/qpid-site/blob/7437c595/content/releases/qpid-proton-master/proton/c/api/group__proactor.html
----------------------------------------------------------------------
diff --git a/content/releases/qpid-proton-master/proton/c/api/group__proactor.html b/content/releases/qpid-proton-master/proton/c/api/group__proactor.html
index 82e29e4..f5fd17c 100755
--- a/content/releases/qpid-proton-master/proton/c/api/group__proactor.html
+++ b/content/releases/qpid-proton-master/proton/c/api/group__proactor.html
@@ -90,27 +90,17 @@ $(document).ready(function(){initNavTree('group__proactor.html','');});
<div class="header">
<div class="summary">
-<a href="#groups">Modules</a> |
<a href="#define-members">Macros</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
-<div class="title">Proactor</div> </div>
+<div class="title">Proactor<div class="ingroups"><a class="el" href="group__io.html">IO</a></div></div> </div>
</div><!--header-->
<div class="contents">
-<p><b>Experimental</b> - Multithreaded IO
+<p><b>Unsettled API</b> - An API for multithreaded IO.
<a href="#details">More...</a></p>
<table class="memberdecls">
-<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
-Modules</h2></td></tr>
-<tr class="memitem:group__listener"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__listener.html">Listener</a></td></tr>
-<tr class="memdesc:group__listener"><td class="mdescLeft"> </td><td class="mdescRight"><b>Experimental</b> - A listener for incoming connections for the <a class="el" href="group__proactor.html">Proactor</a>. <br /></td></tr>
-<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
-<tr class="memitem:group__proactor__events"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proactor__events.html">Events</a></td></tr>
-<tr class="memdesc:group__proactor__events"><td class="mdescLeft"> </td><td class="mdescRight"><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>. <br /></td></tr>
-<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
-</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga29ae114b42fb797c103dc9883ebcb256"><td class="memItemLeft" align="right" valign="top"><a id="ga29ae114b42fb797c103dc9883ebcb256"></a>
@@ -122,13 +112,17 @@ Macros</h2></td></tr>
Typedefs</h2></td></tr>
<tr class="memitem:ga79d820cd3ad391cc5207c83dbb373a9c"><td class="memItemLeft" align="right" valign="top"><a id="ga79d820cd3ad391cc5207c83dbb373a9c"></a>
typedef struct <a class="el" href="group__proactor.html#ga79d820cd3ad391cc5207c83dbb373a9c">pn_netaddr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proactor.html#ga79d820cd3ad391cc5207c83dbb373a9c">pn_netaddr_t</a></td></tr>
-<tr class="memdesc:ga79d820cd3ad391cc5207c83dbb373a9c"><td class="mdescLeft"> </td><td class="mdescRight">Network address of a proactor transport. <br /></td></tr>
+<tr class="memdesc:ga79d820cd3ad391cc5207c83dbb373a9c"><td class="mdescLeft"> </td><td class="mdescRight"><b>Unsettled API</b> - The network address of a proactor transport. <br /></td></tr>
<tr class="separator:ga79d820cd3ad391cc5207c83dbb373a9c"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="memitem:gabba42c7929dfceb9d296535bad0c93dc"><td class="memItemLeft" align="right" valign="top"><a id="gabba42c7929dfceb9d296535bad0c93dc"></a>
+typedef struct <a class="el" href="group__proactor.html#gabba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proactor.html#gabba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a></td></tr>
+<tr class="memdesc:gabba42c7929dfceb9d296535bad0c93dc"><td class="mdescLeft"> </td><td class="mdescRight">A harness for multithreaded IO. <br /></td></tr>
+<tr class="separator:gabba42c7929dfceb9d296535bad0c93dc"><td class="memSeparator" colspan="2"> </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:ga9f6a27999303c6082edc581f880de37c"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proactor.html#ga9f6a27999303c6082edc581f880de37c">pn_netaddr_str</a> (const <a class="el" href="group__proactor.html#ga79d820cd3ad391cc5207c83dbb373a9c">pn_netaddr_t</a> *addr, char *buf, size_t size)</td></tr>
-<tr class="memdesc:ga9f6a27999303c6082edc581f880de37c"><td class="mdescLeft"> </td><td class="mdescRight">Format a network address as a human-readable string in buf. <a href="#ga9f6a27999303c6082edc581f880de37c">More...</a><br /></td></tr>
+<tr class="memdesc:ga9f6a27999303c6082edc581f880de37c"><td class="mdescLeft"> </td><td class="mdescRight">Format a network address as a human-readable string in <code>buf</code>. <a href="#ga9f6a27999303c6082edc581f880de37c">More...</a><br /></td></tr>
<tr class="separator:ga9f6a27999303c6082edc581f880de37c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7edab5e295c55e1c2169e39aaa082f8b"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN const <a class="el" href="group__proactor.html#ga79d820cd3ad391cc5207c83dbb373a9c">pn_netaddr_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proactor.html#ga7edab5e295c55e1c2169e39aaa082f8b">pn_netaddr_local</a> (<a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *t)</td></tr>
<tr class="memdesc:ga7edab5e295c55e1c2169e39aaa082f8b"><td class="mdescLeft"> </td><td class="mdescRight">Get the local address of a transport. <a href="#ga7edab5e295c55e1c2169e39aaa082f8b">More...</a><br /></td></tr>
@@ -145,37 +139,37 @@ Functions</h2></td></tr>
<tr class="memitem:gaf67a7642c9003b36255b58776b494c96"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proactor.html#gaf67a7642c9003b36255b58776b494c96">pn_proactor_addr</a> (char *addr, size_t size, const char *host, const char *port)</td></tr>
<tr class="memdesc:gaf67a7642c9003b36255b58776b494c96"><td class="mdescLeft"> </td><td class="mdescRight">Format a host:port address string for <a class="el" href="group__proactor.html#ga9a9d1c4138226fa87160f4769b87f8e6" title="Bind connection to a new Transport connected to addr. ">pn_proactor_connect()</a> or <a class="el" href="group__proactor.html#gacbed6a4ab75ef8452c10d52e4cd62752" title="Start listening for incoming connections. ">pn_proactor_listen()</a> <a href="#gaf67a7642c9003b36255b58776b494c96">More...</a><br /></td></tr>
<tr class="separator:gaf67a7642c9003b36255b58776b494c96"><td class="memSeparator" colspan="2"> </td></tr>
-<tr class="memitem:gac2a925b3de00efd8cd40fa9920169554"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN <a class="el" href="types_8h.html#abba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proactor.html#gac2a925b3de00efd8cd40fa9920169554">pn_proactor</a> (void)</td></tr>
+<tr class="memitem:gac2a925b3de00efd8cd40fa9920169554"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN <a class="el" href="group__proactor.html#gabba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proactor.html#gac2a925b3de00efd8cd40fa9920169554">pn_proactor</a> (void)</td></tr>
<tr class="memdesc:gac2a925b3de00efd8cd40fa9920169554"><td class="mdescLeft"> </td><td class="mdescRight">Create a proactor. <a href="#gac2a925b3de00efd8cd40fa9920169554">More...</a><br /></td></tr>
<tr class="separator:gac2a925b3de00efd8cd40fa9920169554"><td class="memSeparator" colspan="2"> </td></tr>
-<tr class="memitem:ga5260c2653d4af5eb2f1c8c6190e9d6cf"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proactor.html#ga5260c2653d4af5eb2f1c8c6190e9d6cf">pn_proactor_free</a> (<a class="el" href="types_8h.html#abba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> *proactor)</td></tr>
+<tr class="memitem:ga5260c2653d4af5eb2f1c8c6190e9d6cf"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proactor.html#ga5260c2653d4af5eb2f1c8c6190e9d6cf">pn_proactor_free</a> (<a class="el" href="group__proactor.html#gabba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> *proactor)</td></tr>
<tr class="memdesc:ga5260c2653d4af5eb2f1c8c6190e9d6cf"><td class="mdescLeft"> </td><td class="mdescRight">Free the proactor. <a href="#ga5260c2653d4af5eb2f1c8c6190e9d6cf">More...</a><br /></td></tr>
<tr class="separator:ga5260c2653d4af5eb2f1c8c6190e9d6cf"><td class="memSeparator" colspan="2"> </td></tr>
-<tr class="memitem:ga9a9d1c4138226fa87160f4769b87f8e6"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proactor.html#ga9a9d1c4138226fa87160f4769b87f8e6">pn_proactor_connect</a> (<a class="el" href="types_8h.html#abba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> *proactor, <a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> *connection, const char *addr)</td></tr>
+<tr class="memitem:ga9a9d1c4138226fa87160f4769b87f8e6"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proactor.html#ga9a9d1c4138226fa87160f4769b87f8e6">pn_proactor_connect</a> (<a class="el" href="group__proactor.html#gabba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> *proactor, <a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> *connection, const char *addr)</td></tr>
<tr class="memdesc:ga9a9d1c4138226fa87160f4769b87f8e6"><td class="mdescLeft"> </td><td class="mdescRight">Bind <code>connection</code> to a new <a class="el" href="group__transport.html">Transport</a> connected to <code>addr</code>. <a href="#ga9a9d1c4138226fa87160f4769b87f8e6">More...</a><br /></td></tr>
<tr class="separator:ga9a9d1c4138226fa87160f4769b87f8e6"><td class="memSeparator" colspan="2"> </td></tr>
-<tr class="memitem:gacbed6a4ab75ef8452c10d52e4cd62752"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proactor.html#gacbed6a4ab75ef8452c10d52e4cd62752">pn_proactor_listen</a> (<a class="el" href="types_8h.html#abba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> *proactor, <a class="el" href="group__listener.html#ga68ac7072ae60612d0bca5470014bf216">pn_listener_t</a> *listener, const char *addr, int backlog)</td></tr>
+<tr class="memitem:gacbed6a4ab75ef8452c10d52e4cd62752"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proactor.html#gacbed6a4ab75ef8452c10d52e4cd62752">pn_proactor_listen</a> (<a class="el" href="group__proactor.html#gabba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> *proactor, <a class="el" href="group__listener.html#ga68ac7072ae60612d0bca5470014bf216">pn_listener_t</a> *listener, const char *addr, int backlog)</td></tr>
<tr class="memdesc:gacbed6a4ab75ef8452c10d52e4cd62752"><td class="mdescLeft"> </td><td class="mdescRight">Start listening for incoming connections. <a href="#gacbed6a4ab75ef8452c10d52e4cd62752">More...</a><br /></td></tr>
<tr class="separator:gacbed6a4ab75ef8452c10d52e4cd62752"><td class="memSeparator" colspan="2"> </td></tr>
-<tr class="memitem:gac600bd88ed0fc6c2b66bed4a8740bd68"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proactor.html#gac600bd88ed0fc6c2b66bed4a8740bd68">pn_proactor_disconnect</a> (<a class="el" href="types_8h.html#abba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> *proactor, <a class="el" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a> *condition)</td></tr>
+<tr class="memitem:gac600bd88ed0fc6c2b66bed4a8740bd68"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proactor.html#gac600bd88ed0fc6c2b66bed4a8740bd68">pn_proactor_disconnect</a> (<a class="el" href="group__proactor.html#gabba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> *proactor, <a class="el" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a> *condition)</td></tr>
<tr class="memdesc:gac600bd88ed0fc6c2b66bed4a8740bd68"><td class="mdescLeft"> </td><td class="mdescRight">Disconnect all connections and listeners belonging to the proactor. <a href="#gac600bd88ed0fc6c2b66bed4a8740bd68">More...</a><br /></td></tr>
<tr class="separator:gac600bd88ed0fc6c2b66bed4a8740bd68"><td class="memSeparator" colspan="2"> </td></tr>
-<tr class="memitem:ga2b66a46f3e557010ec61bd105326753d"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN <a class="el" href="group__event.html#ga6bc581dfeaa8e8d46d07d37229d565c9">pn_event_batch_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proactor.html#ga2b66a46f3e557010ec61bd105326753d">pn_proactor_wait</a> (<a class="el" href="types_8h.html#abba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> *proactor)</td></tr>
-<tr class="memdesc:ga2b66a46f3e557010ec61bd105326753d"><td class="mdescLeft"> </td><td class="mdescRight">Wait until there are <a class="el" href="group__proactor__events.html">Events</a> to handle. <a href="#ga2b66a46f3e557010ec61bd105326753d">More...</a><br /></td></tr>
+<tr class="memitem:ga2b66a46f3e557010ec61bd105326753d"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN <a class="el" href="group__event.html#ga6bc581dfeaa8e8d46d07d37229d565c9">pn_event_batch_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proactor.html#ga2b66a46f3e557010ec61bd105326753d">pn_proactor_wait</a> (<a class="el" href="group__proactor.html#gabba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> *proactor)</td></tr>
+<tr class="memdesc:ga2b66a46f3e557010ec61bd105326753d"><td class="mdescLeft"> </td><td class="mdescRight">Wait until there are <a class="el" href="group__proactor__events.html">Proactor events</a> to handle. <a href="#ga2b66a46f3e557010ec61bd105326753d">More...</a><br /></td></tr>
<tr class="separator:ga2b66a46f3e557010ec61bd105326753d"><td class="memSeparator" colspan="2"> </td></tr>
-<tr class="memitem:ga957eae24db6ec4962af79c5a06106115"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN <a class="el" href="group__event.html#ga6bc581dfeaa8e8d46d07d37229d565c9">pn_event_batch_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proactor.html#ga957eae24db6ec4962af79c5a06106115">pn_proactor_get</a> (<a class="el" href="types_8h.html#abba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> *proactor)</td></tr>
-<tr class="memdesc:ga957eae24db6ec4962af79c5a06106115"><td class="mdescLeft"> </td><td class="mdescRight">Return <a class="el" href="group__proactor__events.html">Events</a> if any are available immediately. <a href="#ga957eae24db6ec4962af79c5a06106115">More...</a><br /></td></tr>
+<tr class="memitem:ga957eae24db6ec4962af79c5a06106115"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN <a class="el" href="group__event.html#ga6bc581dfeaa8e8d46d07d37229d565c9">pn_event_batch_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proactor.html#ga957eae24db6ec4962af79c5a06106115">pn_proactor_get</a> (<a class="el" href="group__proactor.html#gabba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> *proactor)</td></tr>
+<tr class="memdesc:ga957eae24db6ec4962af79c5a06106115"><td class="mdescLeft"> </td><td class="mdescRight">Return <a class="el" href="group__proactor__events.html">Proactor events</a> if any are available immediately. <a href="#ga957eae24db6ec4962af79c5a06106115">More...</a><br /></td></tr>
<tr class="separator:ga957eae24db6ec4962af79c5a06106115"><td class="memSeparator" colspan="2"> </td></tr>
-<tr class="memitem:gade60ff2292b74841766f953b906285c0"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proactor.html#gade60ff2292b74841766f953b906285c0">pn_proactor_done</a> (<a class="el" href="types_8h.html#abba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> *proactor, <a class="el" href="group__event.html#ga6bc581dfeaa8e8d46d07d37229d565c9">pn_event_batch_t</a> *events)</td></tr>
+<tr class="memitem:gade60ff2292b74841766f953b906285c0"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proactor.html#gade60ff2292b74841766f953b906285c0">pn_proactor_done</a> (<a class="el" href="group__proactor.html#gabba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> *proactor, <a class="el" href="group__event.html#ga6bc581dfeaa8e8d46d07d37229d565c9">pn_event_batch_t</a> *events)</td></tr>
<tr class="memdesc:gade60ff2292b74841766f953b906285c0"><td class="mdescLeft"> </td><td class="mdescRight">Call when finished handling a batch of events. <a href="#gade60ff2292b74841766f953b906285c0">More...</a><br /></td></tr>
<tr class="separator:gade60ff2292b74841766f953b906285c0"><td class="memSeparator" colspan="2"> </td></tr>
-<tr class="memitem:gaa5255cd1bcb5d7f5639b53dc30712711"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proactor.html#gaa5255cd1bcb5d7f5639b53dc30712711">pn_proactor_interrupt</a> (<a class="el" href="types_8h.html#abba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> *proactor)</td></tr>
+<tr class="memitem:gaa5255cd1bcb5d7f5639b53dc30712711"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proactor.html#gaa5255cd1bcb5d7f5639b53dc30712711">pn_proactor_interrupt</a> (<a class="el" href="group__proactor.html#gabba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> *proactor)</td></tr>
<tr class="memdesc:gaa5255cd1bcb5d7f5639b53dc30712711"><td class="mdescLeft"> </td><td class="mdescRight">Return a <a class="el" href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaaee05826a80e94b5b86c4544e4715f499">PN_PROACTOR_INTERRUPT</a> event as soon as possible. <a href="#gaa5255cd1bcb5d7f5639b53dc30712711">More...</a><br /></td></tr>
<tr class="separator:gaa5255cd1bcb5d7f5639b53dc30712711"><td class="memSeparator" colspan="2"> </td></tr>
-<tr class="memitem:gad7cd71f06282eb290699d90c316b2d32"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proactor.html#gad7cd71f06282eb290699d90c316b2d32">pn_proactor_set_timeout</a> (<a class="el" href="types_8h.html#abba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> *proactor, <a class="el" href="group__api__types.html#ga9a701bc6dc9af9f42c3f4679172a723c">pn_millis_t</a> timeout)</td></tr>
+<tr class="memitem:gad7cd71f06282eb290699d90c316b2d32"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proactor.html#gad7cd71f06282eb290699d90c316b2d32">pn_proactor_set_timeout</a> (<a class="el" href="group__proactor.html#gabba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> *proactor, <a class="el" href="group__api__types.html#ga9a701bc6dc9af9f42c3f4679172a723c">pn_millis_t</a> timeout)</td></tr>
<tr class="memdesc:gad7cd71f06282eb290699d90c316b2d32"><td class="mdescLeft"> </td><td class="mdescRight">Return a <a class="el" href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaa4afa8c2da61f4c665c669fbe37b1c5fe">PN_PROACTOR_TIMEOUT</a> after <code>timeout</code> milliseconds elapse. <a href="#gad7cd71f06282eb290699d90c316b2d32">More...</a><br /></td></tr>
<tr class="separator:gad7cd71f06282eb290699d90c316b2d32"><td class="memSeparator" colspan="2"> </td></tr>
-<tr class="memitem:gac206e4d0a1b7546d940a83cdd79ce93f"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proactor.html#gac206e4d0a1b7546d940a83cdd79ce93f">pn_proactor_cancel_timeout</a> (<a class="el" href="types_8h.html#abba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> *proactor)</td></tr>
+<tr class="memitem:gac206e4d0a1b7546d940a83cdd79ce93f"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proactor.html#gac206e4d0a1b7546d940a83cdd79ce93f">pn_proactor_cancel_timeout</a> (<a class="el" href="group__proactor.html#gabba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> *proactor)</td></tr>
<tr class="memdesc:gac206e4d0a1b7546d940a83cdd79ce93f"><td class="mdescLeft"> </td><td class="mdescRight">Cancel the pending 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>. <a href="#gac206e4d0a1b7546d940a83cdd79ce93f">More...</a><br /></td></tr>
<tr class="separator:gac206e4d0a1b7546d940a83cdd79ce93f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1950236260353f82729dbb4589ef6c27"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proactor.html#ga1950236260353f82729dbb4589ef6c27">pn_proactor_release_connection</a> (<a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> *connection)</td></tr>
@@ -184,10 +178,10 @@ Functions</h2></td></tr>
<tr class="memitem:ga0f49c771fe3bff54f58c9d583ca30560"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proactor.html#ga0f49c771fe3bff54f58c9d583ca30560">pn_connection_wake</a> (<a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> *connection)</td></tr>
<tr class="memdesc:ga0f49c771fe3bff54f58c9d583ca30560"><td class="mdescLeft"> </td><td class="mdescRight">Return a <a class="el" href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaa28a2bfee806bbc1fe31499c8eec39db0">PN_CONNECTION_WAKE</a> event for <code>connection</code> as soon as possible. <a href="#ga0f49c771fe3bff54f58c9d583ca30560">More...</a><br /></td></tr>
<tr class="separator:ga0f49c771fe3bff54f58c9d583ca30560"><td class="memSeparator" colspan="2"> </td></tr>
-<tr class="memitem:ga4727a4e26f19efcff0d48960cbba2f40"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN <a class="el" href="types_8h.html#abba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proactor.html#ga4727a4e26f19efcff0d48960cbba2f40">pn_connection_proactor</a> (<a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> *connection)</td></tr>
+<tr class="memitem:ga4727a4e26f19efcff0d48960cbba2f40"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN <a class="el" href="group__proactor.html#gabba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proactor.html#ga4727a4e26f19efcff0d48960cbba2f40">pn_connection_proactor</a> (<a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> *connection)</td></tr>
<tr class="memdesc:ga4727a4e26f19efcff0d48960cbba2f40"><td class="mdescLeft"> </td><td class="mdescRight">Return the proactor associated with a connection. <a href="#ga4727a4e26f19efcff0d48960cbba2f40">More...</a><br /></td></tr>
<tr class="separator:ga4727a4e26f19efcff0d48960cbba2f40"><td class="memSeparator" colspan="2"> </td></tr>
-<tr class="memitem:gac412771217decd84bd70931acbd0828a"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN <a class="el" href="types_8h.html#abba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proactor.html#gac412771217decd84bd70931acbd0828a">pn_event_proactor</a> (<a class="el" href="group__event.html#ga87f3028b4888632bbd56fb71ac737ae8">pn_event_t</a> *event)</td></tr>
+<tr class="memitem:gac412771217decd84bd70931acbd0828a"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN <a class="el" href="group__proactor.html#gabba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proactor.html#gac412771217decd84bd70931acbd0828a">pn_event_proactor</a> (<a class="el" href="group__event.html#ga87f3028b4888632bbd56fb71ac737ae8">pn_event_t</a> *event)</td></tr>
<tr class="memdesc:gac412771217decd84bd70931acbd0828a"><td class="mdescLeft"> </td><td class="mdescRight">Return the proactor associated with an event. <a href="#gac412771217decd84bd70931acbd0828a">More...</a><br /></td></tr>
<tr class="separator:gac412771217decd84bd70931acbd0828a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad45b60b98f2bf385ee6ca5dca7b3f42d"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN <a class="el" href="group__api__types.html#ga9a701bc6dc9af9f42c3f4679172a723c">pn_millis_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proactor.html#gad45b60b98f2bf385ee6ca5dca7b3f42d">pn_proactor_now</a> (void)</td></tr>
@@ -195,12 +189,14 @@ Functions</h2></td></tr>
<tr class="separator:gad45b60b98f2bf385ee6ca5dca7b3f42d"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
-<p><b>Experimental</b> - Multithreaded IO </p>
+<p><b>Unsettled API</b> - An API for multithreaded IO. </p>
<p>The proactor associates an abstract AMQP protocol <a class="el" href="group__connection.html">Connection</a> with a concrete IO <a class="el" href="group__transport.html">Transport</a> implementation for outgoing and incoming connections.</p>
-<p><a class="el" href="group__proactor.html#ga2b66a46f3e557010ec61bd105326753d" title="Wait until there are Events to handle. ">pn_proactor_wait()</a> returns <a class="el" href="group__proactor__events.html">Events</a> to application threads for handling.</p>
-<p>The <a class="el" href="group__proactor.html#gac2a925b3de00efd8cd40fa9920169554">pn_proactor</a>* functions are thread-safe, but to handle <a class="el" href="group__proactor__events.html">Events</a> you must also use the <a class="el" href="group__core.html">Core</a> APIs which are not. <a class="el" href="group__core.html">Core</a> objects associated with different connections can be used concurrently, but objects associated with a single connection cannot.</p>
-<p>The proactor <em>serializes</em> <a class="el" href="group__proactor__events.html">Events</a> for each connection - it never returns <a class="el" href="group__proactor__events.html">Events</a> for the same connection concurrently in different threads. Event-handling code can safely use any <a class="el" href="group__core.html">Core</a> object obtained from the current event. You can attach application data to <a class="el" href="group__core.html">Core</a> objects (for example with <a class="el" href="group__connection.html#gad8b6c777b525c9da9401e3a770db15da" title="Get the attachments that are associated with a connection object. ">pn_connection_attachments()</a>).</p>
-<p><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> allows any thread to "wake up" a connection. It causes <a class="el" href="group__proactor.html#ga2b66a46f3e557010ec61bd105326753d" title="Wait until there are Events to handle. ">pn_proactor_wait()</a> to return a <a class="el" href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaa28a2bfee806bbc1fe31499c8eec39db0">PN_CONNECTION_WAKE</a> event that is serialized with the connection's other <a class="el" href="group__proactor__events.html">Events</a>. You can use this to implement communication between different connections, or from non-proactor threads.</p>
+<p><a class="el" href="group__proactor.html#ga2b66a46f3e557010ec61bd105326753d" title="Wait until there are Proactor events to handle. ">pn_proactor_wait()</a> returns <a class="el" href="group__proactor__events.html">Proactor events</a> to application threads for handling.</p>
+<p>The <code>pn_proactor_*</code> functions are thread-safe, but to handle <a class="el" href="group__proactor__events.html">Proactor events</a> you must also use the <a class="el" href="group__core.html">Core</a> APIs, which are not. <a class="el" href="group__core.html">Core</a> objects associated with different connections can be used concurrently, but objects associated with a single connection can only be used from their own thread.</p>
+<p>The proactor <em>serializes</em> <a class="el" href="group__proactor__events.html">Proactor events</a> for each connection</p><ul>
+<li>it never returns <a class="el" href="group__proactor__events.html">Proactor events</a> for the same connection concurrently in different threads. Event-handling code can safely use any <a class="el" href="group__core.html">Core</a> object obtained from the current event. You can attach application data to <a class="el" href="group__core.html">Core</a> objects (for example with <a class="el" href="group__connection.html#gad8b6c777b525c9da9401e3a770db15da" title="Get the attachments that are associated with a connection object. ">pn_connection_attachments()</a>).</li>
+</ul>
+<p><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> allows any thread to "wake up" a connection. It causes <a class="el" href="group__proactor.html#ga2b66a46f3e557010ec61bd105326753d" title="Wait until there are Proactor events to handle. ">pn_proactor_wait()</a> to return a <a class="el" href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaa28a2bfee806bbc1fe31499c8eec39db0">PN_CONNECTION_WAKE</a> event that is serialized with the connection's other <a class="el" href="group__proactor__events.html">Proactor events</a>. You can use this to implement communication between different connections, or from non-proactor threads.</p>
<p>Serialization and <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> simplify building applications with a shared thread pool, which serialize work per connection. Many other variations are possible, but you are responsible for any additional synchronization needed. </p>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga9f6a27999303c6082edc581f880de37c"></a>
@@ -235,7 +231,7 @@ Functions</h2></td></tr>
</table>
</div><div class="memdoc">
-<p>Format a network address as a human-readable string in buf. </p>
+<p>Format a network address as a human-readable string in <code>buf</code>. </p>
<dl class="section return"><dt>Returns</dt><dd>the length of the string (excluding trailing '\0'), if >= size then the address was truncated. </dd></dl>
</div>
@@ -257,7 +253,7 @@ Functions</h2></td></tr>
</div><div class="memdoc">
<p>Get the local address of a transport. </p>
-<p>Return NULL if not available. </p>
+<p>Return <code>NULL</code> if not available. </p>
</div>
</div>
@@ -373,8 +369,7 @@ Functions</h2></td></tr>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the length of network address (excluding trailing '\0'), if >= size then the address was truncated </dd></dl>
-<dl><dt><b>Examples: </b></dt><dd><a class="el" href="broker_8c-example.html#a88">broker.c</a>, <a class="el" href="direct_8c-example.html#a96">direct.c</a>, <a class="el" href="receive_8c-example.html#a56">receive.c</a>, and <a class="el" href="send_8c-example.html#a65">send.c</a>.</dd>
-</dl>
+
</div>
</div>
<a id="gac2a925b3de00efd8cd40fa9920169554"></a>
@@ -384,7 +379,7 @@ Functions</h2></td></tr>
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname">PNP_EXTERN <a class="el" href="types_8h.html#abba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a>* pn_proactor </td>
+ <td class="memname">PNP_EXTERN <a class="el" href="group__proactor.html#gabba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a>* pn_proactor </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
@@ -395,8 +390,7 @@ Functions</h2></td></tr>
<p>Create a proactor. </p>
<p>Must be freed with <a class="el" href="group__proactor.html#ga5260c2653d4af5eb2f1c8c6190e9d6cf" title="Free the proactor. ">pn_proactor_free()</a> </p>
-<dl><dt><b>Examples: </b></dt><dd><a class="el" href="broker_8c-example.html#a86">broker.c</a>, <a class="el" href="direct_8c-example.html#a93">direct.c</a>, <a class="el" href="receive_8c-example.html#a54">receive.c</a>, and <a class="el" href="send_8c-example.html#a63">send.c</a>.</dd>
-</dl>
+
</div>
</div>
<a id="ga5260c2653d4af5eb2f1c8c6190e9d6cf"></a>
@@ -408,7 +402,7 @@ Functions</h2></td></tr>
<tr>
<td class="memname">PNP_EXTERN void pn_proactor_free </td>
<td>(</td>
- <td class="paramtype"><a class="el" href="types_8h.html#abba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> * </td>
+ <td class="paramtype"><a class="el" href="group__proactor.html#gabba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> * </td>
<td class="paramname"><em>proactor</em></td><td>)</td>
<td></td>
</tr>
@@ -417,8 +411,7 @@ Functions</h2></td></tr>
<p>Free the proactor. </p>
<p>Abort open connections/listeners, clean up all resources. </p>
-<dl><dt><b>Examples: </b></dt><dd><a class="el" href="broker_8c-example.html#a91">broker.c</a>, <a class="el" href="direct_8c-example.html#a98">direct.c</a>, <a class="el" href="receive_8c-example.html#a59">receive.c</a>, and <a class="el" href="send_8c-example.html#a68">send.c</a>.</dd>
-</dl>
+
</div>
</div>
<a id="ga9a9d1c4138226fa87160f4769b87f8e6"></a>
@@ -430,7 +423,7 @@ Functions</h2></td></tr>
<tr>
<td class="memname">PNP_EXTERN void pn_proactor_connect </td>
<td>(</td>
- <td class="paramtype"><a class="el" href="types_8h.html#abba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> * </td>
+ <td class="paramtype"><a class="el" href="group__proactor.html#gabba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> * </td>
<td class="paramname"><em>proactor</em>, </td>
</tr>
<tr>
@@ -454,8 +447,8 @@ Functions</h2></td></tr>
</div><div class="memdoc">
<p>Bind <code>connection</code> to a new <a class="el" href="group__transport.html">Transport</a> connected to <code>addr</code>. </p>
-<p>Errors are returned as <a class="el" href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaa1ca722ce3c0b2c13a33636cded8430ba">PN_TRANSPORT_CLOSED</a> events by <a class="el" href="group__proactor.html#ga2b66a46f3e557010ec61bd105326753d" title="Wait until there are Events to handle. ">pn_proactor_wait()</a>.</p>
-<dl class="section note"><dt>Note</dt><dd>Thread safe.</dd></dl>
+<p>Errors are returned as <a class="el" href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaa1ca722ce3c0b2c13a33636cded8430ba">PN_TRANSPORT_CLOSED</a> events by <a class="el" href="group__proactor.html#ga2b66a46f3e557010ec61bd105326753d" title="Wait until there are Proactor events to handle. ">pn_proactor_wait()</a>.</p>
+<dl class="section note"><dt>Note</dt><dd>Thread-safe</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">proactor</td><td>the proactor object</td></tr>
@@ -465,8 +458,7 @@ Functions</h2></td></tr>
</table>
</dd>
</dl>
-<dl><dt><b>Examples: </b></dt><dd><a class="el" href="receive_8c-example.html#a57">receive.c</a>, and <a class="el" href="send_8c-example.html#a66">send.c</a>.</dd>
-</dl>
+
</div>
</div>
<a id="gacbed6a4ab75ef8452c10d52e4cd62752"></a>
@@ -478,7 +470,7 @@ Functions</h2></td></tr>
<tr>
<td class="memname">PNP_EXTERN void pn_proactor_listen </td>
<td>(</td>
- <td class="paramtype"><a class="el" href="types_8h.html#abba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> * </td>
+ <td class="paramtype"><a class="el" href="group__proactor.html#gabba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> * </td>
<td class="paramname"><em>proactor</em>, </td>
</tr>
<tr>
@@ -508,8 +500,8 @@ Functions</h2></td></tr>
</div><div class="memdoc">
<p>Start listening for incoming connections. </p>
-<p>Errors are returned as <a class="el" href="group__proactor__events.html">Events</a> by <a class="el" href="group__proactor.html#ga2b66a46f3e557010ec61bd105326753d" title="Wait until there are Events to handle. ">pn_proactor_wait()</a>.</p>
-<dl class="section note"><dt>Note</dt><dd>Thread safe.</dd></dl>
+<p>Errors are returned as <a class="el" href="group__proactor__events.html">Proactor events</a> by <a class="el" href="group__proactor.html#ga2b66a46f3e557010ec61bd105326753d" title="Wait until there are Proactor events to handle. ">pn_proactor_wait()</a>.</p>
+<dl class="section note"><dt>Note</dt><dd>Thread-safe</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">proactor</td><td>the proactor object</td></tr>
@@ -519,8 +511,7 @@ Functions</h2></td></tr>
</table>
</dd>
</dl>
-<dl><dt><b>Examples: </b></dt><dd><a class="el" href="broker_8c-example.html#a89">broker.c</a>, and <a class="el" href="direct_8c-example.html#a97">direct.c</a>.</dd>
-</dl>
+
</div>
</div>
<a id="gac600bd88ed0fc6c2b66bed4a8740bd68"></a>
@@ -532,7 +523,7 @@ Functions</h2></td></tr>
<tr>
<td class="memname">PNP_EXTERN void pn_proactor_disconnect </td>
<td>(</td>
- <td class="paramtype"><a class="el" href="types_8h.html#abba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> * </td>
+ <td class="paramtype"><a class="el" href="group__proactor.html#gabba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> * </td>
<td class="paramname"><em>proactor</em>, </td>
</tr>
<tr>
@@ -550,10 +541,10 @@ Functions</h2></td></tr>
</div><div class="memdoc">
<p>Disconnect all connections and listeners belonging to the proactor. </p>
-<p><a class="el" href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaad5920df168cd28daaf253cad789d8aca">PN_LISTENER_CLOSE</a>, <a class="el" href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaa1ca722ce3c0b2c13a33636cded8430ba">PN_TRANSPORT_CLOSED</a> and other <a class="el" href="group__proactor__events.html">Events</a> are generated as usual.</p>
+<p><a class="el" href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaad5920df168cd28daaf253cad789d8aca">PN_LISTENER_CLOSE</a>, <a class="el" href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaa1ca722ce3c0b2c13a33636cded8430ba">PN_TRANSPORT_CLOSED</a> and other <a class="el" href="group__proactor__events.html">Proactor events</a> are generated as usual.</p>
<p>If no new listeners or connections are created, then a <a class="el" href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaa894e93f167ef39e28a07c9cdf6b1181b">PN_PROACTOR_INACTIVE</a> event will be generated when all connections and listeners are disconnected and no timeout is pending - see <a class="el" href="group__proactor.html#gad7cd71f06282eb290699d90c316b2d32" title="Return a PN_PROACTOR_TIMEOUT after timeout milliseconds elapse. ">pn_proactor_set_timeout()</a> <a class="el" href="group__proactor.html#gac206e4d0a1b7546d940a83cdd79ce93f" title="Cancel the pending timeout set by pn_proactor_set_timeout(). ">pn_proactor_cancel_timeout()</a></p>
<p>Note the proactor remains active, connections and listeners created after a call to <a class="el" href="group__proactor.html#gac600bd88ed0fc6c2b66bed4a8740bd68" title="Disconnect all connections and listeners belonging to the proactor. ">pn_proactor_disconnect()</a> are not affected by it.</p>
-<dl class="section note"><dt>Note</dt><dd>Thread safe.</dd></dl>
+<dl class="section note"><dt>Note</dt><dd>Thread-safe</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">proactor</td><td>the proactor</td></tr>
@@ -573,21 +564,20 @@ Functions</h2></td></tr>
<tr>
<td class="memname">PNP_EXTERN <a class="el" href="group__event.html#ga6bc581dfeaa8e8d46d07d37229d565c9">pn_event_batch_t</a>* pn_proactor_wait </td>
<td>(</td>
- <td class="paramtype"><a class="el" href="types_8h.html#abba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> * </td>
+ <td class="paramtype"><a class="el" href="group__proactor.html#gabba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> * </td>
<td class="paramname"><em>proactor</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
-<p>Wait until there are <a class="el" href="group__proactor__events.html">Events</a> to handle. </p>
+<p>Wait until there are <a class="el" href="group__proactor__events.html">Proactor events</a> to handle. </p>
<p>You must call <a class="el" href="group__proactor.html#gade60ff2292b74841766f953b906285c0" title="Call when finished handling a batch of events. ">pn_proactor_done()</a> when you are finished with the batch, you must not use the batch pointer after calling <a class="el" href="group__proactor.html#gade60ff2292b74841766f953b906285c0" title="Call when finished handling a batch of events. ">pn_proactor_done()</a>.</p>
<p>Normally it is most efficient to handle the entire batch in the calling thread and then call <a class="el" href="group__proactor.html#gade60ff2292b74841766f953b906285c0" title="Call when finished handling a batch of events. ">pn_proactor_done()</a>, but see <a class="el" href="group__proactor.html#gade60ff2292b74841766f953b906285c0" title="Call when finished handling a batch of events. ">pn_proactor_done()</a> for more options.</p>
-<p><a class="el" href="group__proactor.html#ga957eae24db6ec4962af79c5a06106115" title="Return Events if any are available immediately. ">pn_proactor_get()</a> is a non-blocking version of this call.</p>
-<dl class="section note"><dt>Note</dt><dd>Thread Safe.</dd></dl>
+<p><a class="el" href="group__proactor.html#ga957eae24db6ec4962af79c5a06106115" title="Return Proactor events if any are available immediately. ">pn_proactor_get()</a> is a non-blocking version of this call.</p>
+<dl class="section note"><dt>Note</dt><dd>Thread-safe</dd></dl>
<dl class="section return"><dt>Returns</dt><dd>a non-empty batch of events that must be processed in sequence. </dd></dl>
-<dl><dt><b>Examples: </b></dt><dd><a class="el" href="broker_8c-example.html#a83">broker.c</a>, <a class="el" href="direct_8c-example.html#a90">direct.c</a>, <a class="el" href="receive_8c-example.html#a51">receive.c</a>, and <a class="el" href="send_8c-example.html#a60">send.c</a>.</dd>
-</dl>
+
</div>
</div>
<a id="ga957eae24db6ec4962af79c5a06106115"></a>
@@ -599,16 +589,16 @@ Functions</h2></td></tr>
<tr>
<td class="memname">PNP_EXTERN <a class="el" href="group__event.html#ga6bc581dfeaa8e8d46d07d37229d565c9">pn_event_batch_t</a>* pn_proactor_get </td>
<td>(</td>
- <td class="paramtype"><a class="el" href="types_8h.html#abba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> * </td>
+ <td class="paramtype"><a class="el" href="group__proactor.html#gabba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> * </td>
<td class="paramname"><em>proactor</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
-<p>Return <a class="el" href="group__proactor__events.html">Events</a> if any are available immediately. </p>
-<p>If not, return NULL. If the return value is not NULL, the behavior is the same as <a class="el" href="group__proactor.html#ga2b66a46f3e557010ec61bd105326753d" title="Wait until there are Events to handle. ">pn_proactor_wait()</a></p>
-<dl class="section note"><dt>Note</dt><dd>Thread Safe. </dd></dl>
+<p>Return <a class="el" href="group__proactor__events.html">Proactor events</a> if any are available immediately. </p>
+<p>If not, return NULL. If the return value is not NULL, the behavior is the same as <a class="el" href="group__proactor.html#ga2b66a46f3e557010ec61bd105326753d" title="Wait until there are Proactor events to handle. ">pn_proactor_wait()</a></p>
+<dl class="section note"><dt>Note</dt><dd>Thread-safe </dd></dl>
</div>
</div>
@@ -621,7 +611,7 @@ Functions</h2></td></tr>
<tr>
<td class="memname">PNP_EXTERN void pn_proactor_done </td>
<td>(</td>
- <td class="paramtype"><a class="el" href="types_8h.html#abba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> * </td>
+ <td class="paramtype"><a class="el" href="group__proactor.html#gabba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> * </td>
<td class="paramname"><em>proactor</em>, </td>
</tr>
<tr>
@@ -639,10 +629,9 @@ Functions</h2></td></tr>
</div><div class="memdoc">
<p>Call when finished handling a batch of events. </p>
-<p>Must be called exactly once to match each call to <a class="el" href="group__proactor.html#ga2b66a46f3e557010ec61bd105326753d" title="Wait until there are Events to handle. ">pn_proactor_wait()</a>.</p>
+<p>Must be called exactly once to match each call to <a class="el" href="group__proactor.html#ga2b66a46f3e557010ec61bd105326753d" title="Wait until there are Proactor events to handle. ">pn_proactor_wait()</a>.</p>
<dl class="section note"><dt>Note</dt><dd>Thread-safe: May be called from any thread provided the exactly once rule is respected. </dd></dl>
-<dl><dt><b>Examples: </b></dt><dd><a class="el" href="broker_8c-example.html#a85">broker.c</a>, <a class="el" href="direct_8c-example.html#a92">direct.c</a>, <a class="el" href="receive_8c-example.html#a53">receive.c</a>, and <a class="el" href="send_8c-example.html#a62">send.c</a>.</dd>
-</dl>
+
</div>
</div>
<a id="gaa5255cd1bcb5d7f5639b53dc30712711"></a>
@@ -654,7 +643,7 @@ Functions</h2></td></tr>
<tr>
<td class="memname">PNP_EXTERN void pn_proactor_interrupt </td>
<td>(</td>
- <td class="paramtype"><a class="el" href="types_8h.html#abba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> * </td>
+ <td class="paramtype"><a class="el" href="group__proactor.html#gabba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> * </td>
<td class="paramname"><em>proactor</em></td><td>)</td>
<td></td>
</tr>
@@ -664,8 +653,7 @@ Functions</h2></td></tr>
<p>Return a <a class="el" href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaaee05826a80e94b5b86c4544e4715f499">PN_PROACTOR_INTERRUPT</a> event as soon as possible. </p>
<p>At least one PN_PROACTOR_INTERRUPT event will be returned after this call. Interrupts can be "coalesced" - if several <a class="el" href="group__proactor.html#gaa5255cd1bcb5d7f5639b53dc30712711" title="Return a PN_PROACTOR_INTERRUPT event as soon as possible. ">pn_proactor_interrupt()</a> calls happen close together, there may be only one PN_PROACTOR_INTERRUPT event that occurs after all of them.</p>
<dl class="section note"><dt>Note</dt><dd>Thread-safe and async-signal-safe: can be called in a signal handler. This is the only pn_proactor function that is async-signal-safe. </dd></dl>
-<dl><dt><b>Examples: </b></dt><dd><a class="el" href="broker_8c-example.html#a13">broker.c</a>.</dd>
-</dl>
+
</div>
</div>
<a id="gad7cd71f06282eb290699d90c316b2d32"></a>
@@ -677,7 +665,7 @@ Functions</h2></td></tr>
<tr>
<td class="memname">PNP_EXTERN void pn_proactor_set_timeout </td>
<td>(</td>
- <td class="paramtype"><a class="el" href="types_8h.html#abba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> * </td>
+ <td class="paramtype"><a class="el" href="group__proactor.html#gabba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> * </td>
<td class="paramname"><em>proactor</em>, </td>
</tr>
<tr>
@@ -695,9 +683,9 @@ Functions</h2></td></tr>
</div><div class="memdoc">
<p>Return a <a class="el" href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaa4afa8c2da61f4c665c669fbe37b1c5fe">PN_PROACTOR_TIMEOUT</a> after <code>timeout</code> milliseconds elapse. </p>
-<p>If no threads are blocked in <a class="el" href="group__proactor.html#ga2b66a46f3e557010ec61bd105326753d" title="Wait until there are Events to handle. ">pn_proactor_wait()</a> when the timeout elapses, the event will be delivered to the next available thread.</p>
+<p>If no threads are blocked in <a class="el" href="group__proactor.html#ga2b66a46f3e557010ec61bd105326753d" title="Wait until there are Proactor events to handle. ">pn_proactor_wait()</a> when the timeout elapses, the event will be delivered to the next available thread.</p>
<p>Calling <a class="el" href="group__proactor.html#gad7cd71f06282eb290699d90c316b2d32" title="Return a PN_PROACTOR_TIMEOUT after timeout milliseconds elapse. ">pn_proactor_set_timeout()</a> again before the PN_PROACTOR_TIMEOUT is delivered will cancel the previous timeout and deliver an event only after the new timeout.</p>
-<dl class="section note"><dt>Note</dt><dd>Thread safe </dd></dl>
+<dl class="section note"><dt>Note</dt><dd>Thread-safe </dd></dl>
</div>
</div>
@@ -710,7 +698,7 @@ Functions</h2></td></tr>
<tr>
<td class="memname">PNP_EXTERN void pn_proactor_cancel_timeout </td>
<td>(</td>
- <td class="paramtype"><a class="el" href="types_8h.html#abba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> * </td>
+ <td class="paramtype"><a class="el" href="group__proactor.html#gabba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> * </td>
<td class="paramname"><em>proactor</em></td><td>)</td>
<td></td>
</tr>
@@ -719,7 +707,7 @@ Functions</h2></td></tr>
<p>Cancel the pending 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>. </p>
<p>Does nothing if no timeout is set.</p>
-<dl class="section note"><dt>Note</dt><dd>Thread safe </dd></dl>
+<dl class="section note"><dt>Note</dt><dd>Thread-safe </dd></dl>
</div>
</div>
@@ -741,11 +729,11 @@ Functions</h2></td></tr>
<p>Release ownership of <code>connection</code>, disassociate it from its proactor. </p>
<p>The connection and related objects (<a class="el" href="group__session.html">sessions</a>, <a class="el" href="group__link.html">links</a> and so on) remain intact, but the transport is closed and unbound. The proactor will not return any more events for this connection. The caller must call <a class="el" href="group__connection.html#ga00cbef1a9f5062a6e1f113fda923f65e" title="Free a connection object. ">pn_connection_free()</a>, either directly or indirectly by re-using <code>connection</code> in another call to <a class="el" href="group__proactor.html#ga9a9d1c4138226fa87160f4769b87f8e6" title="Bind connection to a new Transport connected to addr. ">pn_proactor_connect()</a> or <a class="el" href="group__proactor.html#gacbed6a4ab75ef8452c10d52e4cd62752" title="Start listening for incoming connections. ">pn_proactor_listen()</a>.</p>
-<dl class="section note"><dt>Note</dt><dd><b>NOT</b> thread safe, call from connection event handler.</dd>
+<dl class="section note"><dt>Note</dt><dd><b>Not thread-safe</b>. Call this function from a connection event handler.</dd>
<dd>
If <code>connection</code> does not belong to a proactor, this call does nothing.</dd>
<dd>
-This has nothing to do with <a class="el" href="group__connection.html#ga7c88b4833cf81d801b27d00b45d137b5" title="Release a connection object. ">pn_connection_release()</a> </dd></dl>
+This has nothing to do with <a class="el" href="group__connection.html#ga7c88b4833cf81d801b27d00b45d137b5" title="Release a connection object. ">pn_connection_release()</a>. </dd></dl>
</div>
</div>
@@ -766,12 +754,11 @@ This has nothing to do with <a class="el" href="group__connection.html#ga7c88b48
</div><div class="memdoc">
<p>Return a <a class="el" href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaa28a2bfee806bbc1fe31499c8eec39db0">PN_CONNECTION_WAKE</a> event for <code>connection</code> as soon as possible. </p>
-<p>At least one wake event will be returned, serialized with other <a class="el" href="group__proactor__events.html">Events</a> for the same connection. Wakes can be "coalesced" - if several <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> calls happen close together, there may be only one PN_CONNECTION_WAKE event that occurs after all of them.</p>
+<p>At least one wake event will be returned, serialized with other <a class="el" href="group__proactor__events.html">Proactor events</a> for the same connection. Wakes can be "coalesced" - if several <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> calls happen close together, there may be only one PN_CONNECTION_WAKE event that occurs after all of them.</p>
<dl class="section note"><dt>Note</dt><dd>If <code>connection</code> does not belong to a proactor, this call does nothing.</dd>
<dd>
-Thread safe </dd></dl>
-<dl><dt><b>Examples: </b></dt><dd><a class="el" href="broker_8c-example.html#a12">broker.c</a>, and <a class="el" href="direct_8c-example.html#a85">direct.c</a>.</dd>
-</dl>
+Thread-safe </dd></dl>
+
</div>
</div>
<a id="ga4727a4e26f19efcff0d48960cbba2f40"></a>
@@ -781,7 +768,7 @@ Thread safe </dd></dl>
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname">PNP_EXTERN <a class="el" href="types_8h.html#abba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a>* pn_connection_proactor </td>
+ <td class="memname">PNP_EXTERN <a class="el" href="group__proactor.html#gabba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a>* pn_connection_proactor </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> * </td>
<td class="paramname"><em>connection</em></td><td>)</td>
@@ -791,7 +778,7 @@ Thread safe </dd></dl>
</div><div class="memdoc">
<p>Return the proactor associated with a connection. </p>
-<dl class="section note"><dt>Note</dt><dd>Not Thread safe.</dd></dl>
+<dl class="section note"><dt>Note</dt><dd><b>Not thread-safe</b></dd></dl>
<dl class="section return"><dt>Returns</dt><dd>the proactor or NULL if the connection does not belong to a proactor. </dd></dl>
</div>
@@ -803,7 +790,7 @@ Thread safe </dd></dl>
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname">PNP_EXTERN <a class="el" href="types_8h.html#abba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a>* pn_event_proactor </td>
+ <td class="memname">PNP_EXTERN <a class="el" href="group__proactor.html#gabba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a>* pn_event_proactor </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__event.html#ga87f3028b4888632bbd56fb71ac737ae8">pn_event_t</a> * </td>
<td class="paramname"><em>event</em></td><td>)</td>
@@ -813,7 +800,7 @@ Thread safe </dd></dl>
</div><div class="memdoc">
<p>Return the proactor associated with an event. </p>
-<dl class="section note"><dt>Note</dt><dd>Not Thread safe.</dd></dl>
+<dl class="section note"><dt>Note</dt><dd><b>Not thread-safe</b></dd></dl>
<dl class="section return"><dt>Returns</dt><dd>the proactor or NULL if the connection does not belong to a proactor. </dd></dl>
</div>
@@ -837,7 +824,7 @@ Thread safe </dd></dl>
<p>Get the real elapsed time since an arbitrary point in the past in milliseconds. </p>
<p>This may be used as a portable way to get a process-local timestamp for the current time. It is monotonically increasing and will never go backwards.</p>
<p>Note: this is not a suitable value for an AMQP timestamp to be sent as part of a message. Such a timestamp should use the real time in milliseconds since the epoch.</p>
-<dl class="section note"><dt>Note</dt><dd>Thread safe. </dd></dl>
+<dl class="section note"><dt>Note</dt><dd>Thread-safe </dd></dl>
</div>
</div>
http://git-wip-us.apache.org/repos/asf/qpid-site/blob/7437c595/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 3c86402..5cfcb1a 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,9 +1,8 @@
var group__proactor =
[
- [ "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_proactor_t", "group__proactor.html#gabba42c7929dfceb9d296535bad0c93dc", 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 ],
http://git-wip-us.apache.org/repos/asf/qpid-site/blob/7437c595/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
index af179f3..3da8e6e 100755
--- 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
@@ -5,7 +5,7 @@
<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>
+<title>Qpid Proton C API: Proactor 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>
@@ -90,14 +90,15 @@ $(document).ready(function(){initNavTree('group__proactor__events.html','');});
<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 class="title">Proactor events<div class="ingroups"><a class="el" href="group__io.html">IO</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>.
+<p><b>Unsettled API</b> - Events used by the proactor.
<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>
+<p><b>Unsettled API</b> - Events used by the proactor. </p>
+<p><a class="el" href="group__proactor.html#ga2b66a46f3e557010ec61bd105326753d" title="Wait until there are Proactor 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>.</p>
+<p>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>
http://git-wip-us.apache.org/repos/asf/qpid-site/blob/7437c595/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 09002d6..1d98dec 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
@@ -228,8 +228,7 @@ 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#a37">broker.c</a>, and <a class="el" href="direct_8c-example.html#a68">direct.c</a>.</dd>
-</dl>
+
</div>
</div>
<a id="ga1737191972d5dded0993bf1431e71df0"></a>
@@ -398,8 +397,7 @@ Functions</h2></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 id="gaf472325bc055bb18a5a6f5ca03eda315"></a>
http://git-wip-us.apache.org/repos/asf/qpid-site/blob/7437c595/content/releases/qpid-proton-master/proton/c/api/group__session.html
----------------------------------------------------------------------
diff --git a/content/releases/qpid-proton-master/proton/c/api/group__session.html b/content/releases/qpid-proton-master/proton/c/api/group__session.html
index 3bef661..9904d28 100755
--- a/content/releases/qpid-proton-master/proton/c/api/group__session.html
+++ b/content/releases/qpid-proton-master/proton/c/api/group__session.html
@@ -212,8 +212,7 @@ Functions</h2></td></tr>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a pointer to the new session </dd></dl>
-<dl><dt><b>Examples: </b></dt><dd><a class="el" href="receive_8c-example.html#a18">receive.c</a>, and <a class="el" href="send_8c-example.html#a29">send.c</a>.</dd>
-</dl>
+
</div>
</div>
<a id="ga0f95b5177494a68991d75444c2f6f812"></a>
@@ -240,8 +239,7 @@ Functions</h2></td></tr>
</table>
</dd>
</dl>
-<dl><dt><b>Examples: </b></dt><dd><a class="el" href="broker_8c-example.html#a74">broker.c</a>.</dd>
-</dl>
+
</div>
</div>
<a id="ga07da6cda67bdb37511b0aa9c8a04d532"></a>
@@ -259,7 +257,6 @@ Functions</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
-<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000010">Deprecated:</a></b></dt><dd></dd></dl>
<p>Get the application context that is associated with a session object.</p>
<p>The application context for a session may be set using <a class="el" href="group__session.html#ga31f2e4cc76135f79e96453aa72d441b2">pn_session_set_context</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
@@ -297,7 +294,6 @@ Functions</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
-<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000011">Deprecated:</a></b></dt><dd></dd></dl>
<p>Set a new application context for a session object.</p>
<p>The application context for a session object may be retrieved using <a class="el" href="group__session.html#ga07da6cda67bdb37511b0aa9c8a04d532">pn_session_get_context</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
@@ -379,7 +375,6 @@ Functions</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
-<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000012">Deprecated:</a></b></dt><dd></dd></dl>
<p>Get additional error information associated with the session.</p>
<p>Whenever a session operation fails (i.e. returns an error code), additional error details can be obtained using this function. The error object that is returned may also be used to clear the error condition.</p>
<p>The pointer returned by this operation is valid until the session object is freed.</p>
@@ -448,8 +443,7 @@ Functions</h2></td></tr>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the session's remote condition object </dd></dl>
-<dl><dt><b>Examples: </b></dt><dd><a class="el" href="broker_8c-example.html#a72">broker.c</a>, <a class="el" href="direct_8c-example.html#a80">direct.c</a>, <a class="el" href="receive_8c-example.html#a44">receive.c</a>, and <a class="el" href="send_8c-example.html#a54">send.c</a>.</dd>
-</dl>
+
</div>
</div>
<a id="gaa45a8aa758334528a86cb7914ebe8545"></a>
@@ -477,8 +471,7 @@ Functions</h2></td></tr>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the parent connection object </dd></dl>
-<dl><dt><b>Examples: </b></dt><dd><a class="el" href="broker_8c-example.html#a1">broker.c</a>, <a class="el" href="direct_8c-example.html#a47">direct.c</a>, and <a class="el" href="receive_8c-example.html#a37">receive.c</a>.</dd>
-</dl>
+
</div>
</div>
<a id="ga2b345eada2c15249caaefaa894d1aae3"></a>
@@ -505,8 +498,7 @@ Functions</h2></td></tr>
</table>
</dd>
</dl>
-<dl><dt><b>Examples: </b></dt><dd><a class="el" href="broker_8c-example.html#a44">broker.c</a>, <a class="el" href="direct_8c-example.html#a72">direct.c</a>, <a class="el" href="receive_8c-example.html#a19">receive.c</a>, and <a class="el" href="send_8c-example.html#a30">send.c</a>.</dd>
-</dl>
+
</div>
</div>
<a id="ga12e5c4e71b0df4087d16ccc8b63b42b5"></a>
@@ -533,8 +525,7 @@ Functions</h2></td></tr>
</table>
</dd>
</dl>
-<dl><dt><b>Examples: </b></dt><dd><a class="el" href="broker_8c-example.html#a73">broker.c</a>, <a class="el" href="direct_8c-example.html#a46">direct.c</a>, and <a class="el" href="receive_8c-example.html#a36">receive.c</a>.</dd>
-</dl>
+
</div>
</div>
<a id="ga1fdeb3d6606e869790a228d847136cb0"></a>
http://git-wip-us.apache.org/repos/asf/qpid-site/blob/7437c595/content/releases/qpid-proton-master/proton/c/api/group__terminus.html
----------------------------------------------------------------------
diff --git a/content/releases/qpid-proton-master/proton/c/api/group__terminus.html b/content/releases/qpid-proton-master/proton/c/api/group__terminus.html
index 0018ca4..67016e6 100755
--- a/content/releases/qpid-proton-master/proton/c/api/group__terminus.html
+++ b/content/releases/qpid-proton-master/proton/c/api/group__terminus.html
@@ -411,8 +411,7 @@ Functions</h2></td></tr>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a pointer to the address </dd></dl>
-<dl><dt><b>Examples: </b></dt><dd><a class="el" href="broker_8c-example.html#a16">broker.c</a>.</dd>
-</dl>
+
</div>
</div>
<a id="ga0603db45f03fcef0ef18f4f89ebf3de1"></a>
@@ -450,8 +449,7 @@ Functions</h2></td></tr>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success or an error code on failure </dd></dl>
-<dl><dt><b>Examples: </b></dt><dd><a class="el" href="broker_8c-example.html#a49">broker.c</a>, <a class="el" href="direct_8c-example.html#a48">direct.c</a>, <a class="el" href="receive_8c-example.html#a21">receive.c</a>, and <a class="el" href="send_8c-example.html#a32">send.c</a>.</dd>
-</dl>
+
</div>
</div>
<a id="ga5edfc0f1d61880e1951c21f92c19af53"></a>
http://git-wip-us.apache.org/repos/asf/qpid-site/blob/7437c595/content/releases/qpid-proton-master/proton/c/api/group__transport.html
----------------------------------------------------------------------
diff --git a/content/releases/qpid-proton-master/proton/c/api/group__transport.html b/content/releases/qpid-proton-master/proton/c/api/group__transport.html
index c71f36e..9a65c22 100755
--- a/content/releases/qpid-proton-master/proton/c/api/group__transport.html
+++ b/content/releases/qpid-proton-master/proton/c/api/group__transport.html
@@ -109,14 +109,14 @@ Macros</h2></td></tr>
<tr class="separator:gae8f32e46e94953bab10bee530eee9044"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gafde0eb3c73fb98816f4238d42d48f3d8"><td class="memItemLeft" align="right" valign="top"><a id="gafde0eb3c73fb98816f4238d42d48f3d8"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transport.html#gafde0eb3c73fb98816f4238d42d48f3d8">PN_TRACE_RAW</a></td></tr>
-<tr class="memdesc:gafde0eb3c73fb98816f4238d42d48f3d8"><td class="mdescLeft"> </td><td class="mdescRight">Log raw binary data into/out of the transport. <br /></td></tr>
+<tr class="memdesc:gafde0eb3c73fb98816f4238d42d48f3d8"><td class="mdescLeft"> </td><td class="mdescRight">Log raw binary data going in and out of the transport. <br /></td></tr>
<tr class="separator:gafde0eb3c73fb98816f4238d42d48f3d8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab8e04b4c128379ff27e6b801c0bce494"><td class="memItemLeft" align="right" valign="top"><a id="gab8e04b4c128379ff27e6b801c0bce494"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transport.html#gab8e04b4c128379ff27e6b801c0bce494">PN_TRACE_FRM</a></td></tr>
-<tr class="memdesc:gab8e04b4c128379ff27e6b801c0bce494"><td class="mdescLeft"> </td><td class="mdescRight">Log frames into/out of the transport. <br /></td></tr>
+<tr class="memdesc:gab8e04b4c128379ff27e6b801c0bce494"><td class="mdescLeft"> </td><td class="mdescRight">Log protocol frames going in and out of the transport. <br /></td></tr>
<tr class="separator:gab8e04b4c128379ff27e6b801c0bce494"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7065ad65f95c995a24e416edc95aead4"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transport.html#ga7065ad65f95c995a24e416edc95aead4">PN_TRACE_DRV</a></td></tr>
-<tr class="memdesc:ga7065ad65f95c995a24e416edc95aead4"><td class="mdescLeft"> </td><td class="mdescRight">Log driver related events, e.g. <a href="#ga7065ad65f95c995a24e416edc95aead4">More...</a><br /></td></tr>
+<tr class="memdesc:ga7065ad65f95c995a24e416edc95aead4"><td class="mdescLeft"> </td><td class="mdescRight">Log driver-related events. <a href="#ga7065ad65f95c995a24e416edc95aead4">More...</a><br /></td></tr>
<tr class="separator:ga7065ad65f95c995a24e416edc95aead4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3bde88d15fcfda400a36d8f9e5d51688"><td class="memItemLeft" align="right" valign="top"><a id="ga3bde88d15fcfda400a36d8f9e5d51688"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transport.html#ga3bde88d15fcfda400a36d8f9e5d51688">PN_TRACE_EVT</a></td></tr>
@@ -133,7 +133,7 @@ typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el"
<tr class="memdesc:gae9b49fcbf6397e6916eb4e1357c90ff3"><td class="mdescLeft"> </td><td class="mdescRight">Callback for customizing logging behaviour. <br /></td></tr>
<tr class="separator:gae9b49fcbf6397e6916eb4e1357c90ff3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac26eda05f649bbf0399f3d8d78d12fa8"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a></td></tr>
-<tr class="memdesc:gac26eda05f649bbf0399f3d8d78d12fa8"><td class="mdescLeft"> </td><td class="mdescRight">An AMQP Transport object. <a href="#gac26eda05f649bbf0399f3d8d78d12fa8">More...</a><br /></td></tr>
+<tr class="memdesc:gac26eda05f649bbf0399f3d8d78d12fa8"><td class="mdescLeft"> </td><td class="mdescRight">A network channel supporting an AMQP connection. <a href="#gac26eda05f649bbf0399f3d8d78d12fa8">More...</a><br /></td></tr>
<tr class="separator:gac26eda05f649bbf0399f3d8d78d12fa8"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
@@ -302,8 +302,8 @@ bool </td><td class="memItemRight" valign="bottom"><a class="el" href="grou
</table>
</div><div class="memdoc">
-<p>Log driver related events, e.g. </p>
-<p>initialization, end of stream, etc. </p>
+<p>Log driver-related events. </p>
+<p>For example, initialization, end of stream, and so on. </p>
</div>
</div>
@@ -324,9 +324,9 @@ bool </td><td class="memItemRight" valign="bottom"><a class="el" href="grou
<p>The trace flags for an AMQP transport control what sort of information is logged by an AMQP transport. The following bits can be set:</p>
<ul>
<li><a class="el" href="group__transport.html#gae8f32e46e94953bab10bee530eee9044" title="Turn logging off entirely. ">PN_TRACE_OFF</a></li>
-<li><a class="el" href="group__transport.html#gafde0eb3c73fb98816f4238d42d48f3d8" title="Log raw binary data into/out of the transport. ">PN_TRACE_RAW</a></li>
-<li><a class="el" href="group__transport.html#gab8e04b4c128379ff27e6b801c0bce494" title="Log frames into/out of the transport. ">PN_TRACE_FRM</a></li>
-<li><a class="el" href="group__transport.html#ga7065ad65f95c995a24e416edc95aead4" title="Log driver related events, e.g. ">PN_TRACE_DRV</a></li>
+<li><a class="el" href="group__transport.html#gafde0eb3c73fb98816f4238d42d48f3d8" title="Log raw binary data going in and out of the transport. ">PN_TRACE_RAW</a></li>
+<li><a class="el" href="group__transport.html#gab8e04b4c128379ff27e6b801c0bce494" title="Log protocol frames going in and out of the transport. ">PN_TRACE_FRM</a></li>
+<li><a class="el" href="group__transport.html#ga7065ad65f95c995a24e416edc95aead4" title="Log driver-related events. ">PN_TRACE_DRV</a></li>
<li><a class="el" href="group__transport.html#ga3bde88d15fcfda400a36d8f9e5d51688" title="Log events. ">PN_TRACE_EVT</a> </li>
</ul>
@@ -344,7 +344,7 @@ bool </td><td class="memItemRight" valign="bottom"><a class="el" href="grou
</table>
</div><div class="memdoc">
-<p>An AMQP Transport object. </p>
+<p>A network channel supporting an AMQP connection. </p>
<p>A pn_transport_t encapsulates the transport related state of all AMQP endpoint objects associated with a physical network connection at a given point in time. </p>
</div>
@@ -498,8 +498,7 @@ bool </td><td class="memItemRight" valign="bottom"><a class="el" href="grou
</table>
</dd>
</dl>
-<dl><dt><b>Examples: </b></dt><dd><a class="el" href="broker_8c-example.html#a35">broker.c</a>, and <a class="el" href="direct_8c-example.html#a66">direct.c</a>.</dd>
-</dl>
+
</div>
</div>
<a id="ga8a60f6a48e4bd2d090f5bd264cf7f90d"></a>
@@ -626,8 +625,7 @@ bool </td><td class="memItemRight" valign="bottom"><a class="el" href="grou
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the transport's condition object </dd></dl>
-<dl><dt><b>Examples: </b></dt><dd><a class="el" href="broker_8c-example.html#a66">broker.c</a>, <a class="el" href="direct_8c-example.html#a75">direct.c</a>, <a class="el" href="receive_8c-example.html#a39">receive.c</a>, and <a class="el" href="send_8c-example.html#a49">send.c</a>.</dd>
-</dl>
+
</div>
</div>
<a id="gaede0bc2a0038ccdc7e1b193e322147fa"></a>
@@ -645,7 +643,6 @@ bool </td><td class="memItemRight" valign="bottom"><a class="el" href="grou
</tr>
</table>
</div><div class="memdoc">
-<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000013">Deprecated:</a></b></dt><dd></dd></dl>
</div>
</div>
@@ -819,7 +816,6 @@ bool </td><td class="memItemRight" valign="bottom"><a class="el" href="grou
</tr>
</table>
</div><div class="memdoc">
-<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000014">Deprecated:</a></b></dt><dd></dd></dl>
<p>Get the application context that is associated with a transport object.</p>
<p>The application context for a transport may be set using <a class="el" href="group__transport.html#gac22041ff85d1a1f5287ac2ba826edb74">pn_transport_set_context</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
@@ -857,7 +853,6 @@ bool </td><td class="memItemRight" valign="bottom"><a class="el" href="grou
</tr>
</table>
</div><div class="memdoc">
-<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000015">Deprecated:</a></b></dt><dd></dd></dl>
<p>Set a new application context for a transport object.</p>
<p>The application context for a transport object may be retrieved using <a class="el" href="group__transport.html#ga000b2b9ab82139defb1a103f220ec58e">pn_transport_get_context</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
@@ -1338,7 +1333,6 @@ bool </td><td class="memItemRight" valign="bottom"><a class="el" href="grou
</tr>
</table>
</div><div class="memdoc">
-<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000016">Deprecated:</a></b></dt><dd></dd></dl>
</div>
</div>
@@ -1373,7 +1367,6 @@ bool </td><td class="memItemRight" valign="bottom"><a class="el" href="grou
</tr>
</table>
</div><div class="memdoc">
-<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000017">Deprecated:</a></b></dt><dd></dd></dl>
</div>
</div>
http://git-wip-us.apache.org/repos/asf/qpid-site/blob/7437c595/content/releases/qpid-proton-master/proton/c/api/group__url.html
----------------------------------------------------------------------
diff --git a/content/releases/qpid-proton-master/proton/c/api/group__url.html b/content/releases/qpid-proton-master/proton/c/api/group__url.html
index 1c70b76..2e216f8 100755
--- a/content/releases/qpid-proton-master/proton/c/api/group__url.html
+++ b/content/releases/qpid-proton-master/proton/c/api/group__url.html
@@ -97,7 +97,7 @@ $(document).ready(function(){initNavTree('group__url.html','');});
</div><!--header-->
<div class="contents">
-<p><b>Deprecated</b> - A URL parser
+<p><b>Deprecated</b> - Use a third-party URL library.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
@@ -177,8 +177,7 @@ void </td><td class="memItemRight" valign="bottom"><b>pn_url_set_path</b> (
<tr class="separator:gac72ebae7180d58003d489f2e4005d0c1"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
-<p><b>Deprecated</b> - A URL parser </p>
-<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000019">Deprecated:</a></b></dt><dd></dd></dl>
+<p><b>Deprecated</b> - Use a third-party URL library. </p>
<h2 class="groupheader">Function Documentation</h2>
<a id="gaaa9f2f29b90525fbf73739cae8b84776"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaaa9f2f29b90525fbf73739cae8b84776">◆ </a></span>pn_url_parse()</h2>
http://git-wip-us.apache.org/repos/asf/qpid-site/blob/7437c595/content/releases/qpid-proton-master/proton/c/api/index.html
----------------------------------------------------------------------
diff --git a/content/releases/qpid-proton-master/proton/c/api/index.html b/content/releases/qpid-proton-master/proton/c/api/index.html
index 19954e6..5914d6e 100755
--- a/content/releases/qpid-proton-master/proton/c/api/index.html
+++ b/content/releases/qpid-proton-master/proton/c/api/index.html
@@ -93,17 +93,15 @@ $(document).ready(function(){initNavTree('index.html','');});
<div class="title">Introduction </div> </div>
</div><!--header-->
<div class="contents">
-<div class="textblock"><p>This is the C API for the Proton AMQP protocol engine. It allows you to write client and server applications that send and receive AMQP messages.</p>
-<h2>Core</h2>
-<p><a class="el" href="group__core.html">Core</a> is a collection of types and functions representing AMQP concepts. Together they form a "protocol engine" API to create AMQP connections and links, handle <a class="el" href="group__event.html">events</a>, and send and receive <a class="el" href="group__message.html">messages</a>.</p>
-<h2>Types</h2>
-<p><a class="el" href="group__types.html">Types</a> contains C data types, including <a class="el" href="group__amqp__types.html">AMQP data types</a> and <a class="el" href="group__api__types.html">API data types</a>.</p>
-<h2>Codec</h2>
-<p><a class="el" href="group__codec.html">Codec</a> has functions for AMQP data encoding and decoding.</p>
-<h2>Proactor</h2>
-<p>The <a class="el" href="group__proactor.html">Proactor</a> is a portable, proactive, asynchronous API for single- or multithreaded applications. It associates AMQP <a class="el" href="group__connection.html">connections</a> with network connections (<a class="el" href="group__transport.html">transports</a>) and allows one or more threads to handle <a class="el" href="group__event.html">events</a>.</p>
-<h2>Low-level IO integration</h2>
-<p>The <a class="el" href="group__connection__driver.html">Connection driver</a> Connection Driver is a low-level SPI to feed byte streams from any source to the protocol engine. You can use it to integrate Proton directly with a foreign event loop or IO library, or to implement your own <a class="el" href="group__proactor.html">Proactor</a> to transparently replace Proton's IO layer. </p>
+<div class="textblock"><p>The Qpid Proton C API enables writing clients and servers that send and receive messages using the AMQP protocol. It is part of the <a href="https://qpid.apache.org/proton/index.html">Qpid Proton</a> suite of messaging APIs.</p>
+<h2>Modules</h2>
+<p>The <a class="el" href="group__core.html">Core</a> module is a collection of types and functions representing AMQP concepts and key elements of the API. Together they form a "protocol engine" API to create AMQP <a class="el" href="group__connection.html">connections</a> and <a class="el" href="group__link.html">links</a>, handle <a class="el" href="group__event.html">events</a>, and send and receive <a class="el" href="group__message.html">messages</a>.</p>
+<p>The <a class="el" href="group__types.html">Types</a> module contains C types and functions for handling AMQP- and API-specific data types.</p>
+<p>The <a class="el" href="group__codec.html">Codec</a> module has functions for AMQP data encoding and decoding.</p>
+<p>The <a class="el" href="group__io.html">IO</a> module contains interfaces for integrating with platform-native network IO. See <a class="el" href="io_page.html">IO integration</a> for more information.</p>
+<h2>Conventions</h2>
+<p>Elements of the API marked as <b>Unsettled API</b>, including any elements contained within them, are still evolving and thus are subject to change. They are available to use, but newer versions of Proton may require changes to your application source code.</p>
+<p>Elements marked <b>Deprecated</b> are slated for removal in a future release. </p>
</div></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org