http://git-wip-us.apache.org/repos/asf/qpid-site/blob/7437c595/content/releases/qpid-proton-master/proton/c/api/proactor_8h.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-master/proton/c/api/proactor_8h.html b/content/releases/qpid-proton-master/proton/c/api/proactor_8h.html index 4deadfc..c08d3c5 100755 --- a/content/releases/qpid-proton-master/proton/c/api/proactor_8h.html +++ b/content/releases/qpid-proton-master/proton/c/api/proactor_8h.html @@ -97,7 +97,7 @@ $(document).ready(function(){initNavTree('proactor_8h.html','');}); </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> <div class="textblock"><code>#include <<a class="el" href="condition_8h_source.html">proton/condition.h</a>></code><br /> <code>#include <<a class="el" href="event_8h_source.html">proton/event.h</a>></code><br /> @@ -118,37 +118,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="group__proactor.html#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="group__proactor.html#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="group__proactor.html#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="group__proactor.html#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="group__proactor.html#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="group__proactor.html#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="group__proactor.html#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="group__proactor.html#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="group__proactor.html#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="group__proactor.html#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="group__proactor.html#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="group__proactor.html#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="group__proactor.html#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="group__proactor.html#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> @@ -157,10 +157,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="group__proactor.html#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="group__proactor.html#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="group__proactor.html#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> @@ -168,13 +168,7 @@ 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> -<div class="textblock"><p><b>Experimental</b> - 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>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> +<div class="textblock"><p><b>Unsettled API</b> - An API for multithreaded IO. </p> </div></div><!-- contents --> </div><!-- doc-content --> <!-- start footer part -->
http://git-wip-us.apache.org/repos/asf/qpid-site/blob/7437c595/content/releases/qpid-proton-master/proton/c/api/proactor_8h_source.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-master/proton/c/api/proactor_8h_source.html b/content/releases/qpid-proton-master/proton/c/api/proactor_8h_source.html index f6d6748..2bd4983 100755 --- a/content/releases/qpid-proton-master/proton/c/api/proactor_8h_source.html +++ b/content/releases/qpid-proton-master/proton/c/api/proactor_8h_source.html @@ -93,30 +93,30 @@ $(document).ready(function(){initNavTree('proactor_8h_source.html','');}); <div class="title">proactor.h</div> </div> </div><!--header--> <div class="contents"> -<a href="proactor_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#ifndef PROTON_PROACTOR_H</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define PROTON_PROACTOR_H 1</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> </div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">/*</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * or more contributor license agreements. See the NOTICE file</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</spa n> <span class="comment"> * distributed with this work for additional information</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * regarding copyright ownership. The ASF licenses this file</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * to you under the Apache License, Version 2.0 (the</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * "License"); you may not use this file except in compliance</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * with the License. You may obtain a copy of the License at</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> *</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span cl ass="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> *</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * Unless required by applicable law or agreed to in writing,</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * software distributed under the License is distributed on an</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * KIND, either express or implied. See the License for the</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * spe cific language governing permissions and limitations</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * under the License.</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> */</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <<a class="code" href="condition_8h.html">proton/condition.h</a>></span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <<a class="code" href="event_8h.html">proton/event.h</a>></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <proton/import_export.h></span></div><div class="line"><a name="l00026"></a><span class="l ineno"> 26</span> <span class="preprocessor">#include <<a class="code" href="types_8h.html">proton/types.h</a>></span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div><div class="line"><a name="l00071"></a><span class="lineno"><a class="line" href="group__proactor.html#ga29ae114b42fb797c103dc9883ebcb256"> 71</a></span> <span class="preprocessor">#define PN_MAX_ADDR 1060</span></div><div class="line"><a name="l00072"></ a><span class="lineno"> 72</span> </div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> PNP_EXTERN <span class="keywordtype">int</span> <a class="code" href="group__proactor.html#gaf67a7642c9003b36255b58776b494c96">pn_proactor_addr</a>(<span class="keywordtype">char</span> *addr, <span class="keywordtype">size_t</span> size, <span class="keyword">const</span> <span class="keywordtype">char</span> *host, <span class="keyword">const</span> <span class="keywordtype">char</span> *port);</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> PNP_EXTERN <a class="code" href="types_8h.html#abba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> *<a class="code" href="group__proactor.html#gac2a925b3de00efd8cd40fa9920169554">pn_proactor</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00089"></a><span class="lineno"> 8 9</span> </div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> PNP_EXTERN <span class="keywordtype">void</span> <a class="code" href="group__proactor.html#ga5260c2653d4af5eb2f1c8c6190e9d6cf">pn_proactor_free</a>(<a class="code" href="types_8h.html#abba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> *proactor);</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> PNP_EXTERN <span class="keywordtype">void</span> <a class="code" href="group__proactor.html#ga9a9d1c4138226fa87160f4769b87f8e6">pn_proactor_connect</a>(<a class="code" href="types_8h.html#abba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> *proactor, <a class="code" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> *connection, <span class="keyword">const</span> <span class="keywordtype">char</span> *addr);</div><div class="line"><a name="l00 117"></a><span class="lineno"> 117</span> </div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> PNP_EXTERN <span class="keywordtype">void</span> <a class="code" href="group__proactor.html#gacbed6a4ab75ef8452c10d52e4cd62752">pn_proactor_listen</a>(<a class="code" href="types_8h.html#abba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> *proactor, <a class="code" href="group__listener.html#ga68ac7072ae60612d0bca5470014bf216">pn_listener_t</a> *listener, <span class="keyword">const</span> <span class="keywordtype">char</span> *addr, <span class="keywordtype">int</span> backlog);</div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span> </div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span> PNP_EXTERN <span class="keywordtype">void</span> <a class="code" href="group__proactor.html#gac600bd88ed0fc6c2b66bed4a8740bd68">pn_proactor_disconnect</a>(<a class="code" href="types_8h.html#abba42c7929dfceb9d296 535bad0c93dc">pn_proactor_t</a> *proactor, <a class="code" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a> *condition);</div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span> </div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span> PNP_EXTERN <a class="code" href="group__event.html#ga6bc581dfeaa8e8d46d07d37229d565c9">pn_event_batch_t</a> *<a class="code" href="group__proactor.html#ga2b66a46f3e557010ec61bd105326753d">pn_proactor_wait</a>(<a class="code" href="types_8h.html#abba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> *proactor);</div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span> </div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span> PNP_EXTERN <a class="code" href="group__event.html#ga6bc581dfeaa8e8d46d07d37229d565c9">pn_event_batch_t</a> *<a class="code" href="group__proactor.html#ga957eae24db6ec4962af79c5a06106115">pn_proacto r_get</a>(<a class="code" href="types_8h.html#abba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> *proactor);</div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span> </div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span> PNP_EXTERN <span class="keywordtype">void</span> <a class="code" href="group__proactor.html#gade60ff2292b74841766f953b906285c0">pn_proactor_done</a>(<a class="code" href="types_8h.html#abba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> *proactor, <a class="code" href="group__event.html#ga6bc581dfeaa8e8d46d07d37229d565c9">pn_event_batch_t</a> *events);</div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span> </div><div class="line"><a name="l00210"></a><span class="lineno"> 210</span> PNP_EXTERN <span class="keywordtype">void</span> <a class="code" href="group__proactor.html#gaa5255cd1bcb5d7f5639b53dc30712711">pn_proactor_interrupt</a>(<a class="code" href="types_8h.html#abba42 c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> *proactor);</div><div class="line"><a name="l00211"></a><span class="lineno"> 211</span> </div><div class="line"><a name="l00223"></a><span class="lineno"> 223</span> PNP_EXTERN <span class="keywordtype">void</span> <a class="code" href="group__proactor.html#gad7cd71f06282eb290699d90c316b2d32">pn_proactor_set_timeout</a>(<a class="code" href="types_8h.html#abba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> *proactor, <a class="code" href="group__api__types.html#ga9a701bc6dc9af9f42c3f4679172a723c">pn_millis_t</a> timeout);</div><div class="line"><a name="l00224"></a><span class="lineno"> 224</span> </div><div class="line"><a name="l00231"></a><span class="lineno"> 231</span> PNP_EXTERN <span class="keywordtype">void</span> <a class="code" href="group__proactor.html#gac206e4d0a1b7546d940a83cdd79ce93f">pn_proactor_cancel_timeout</a>(<a class="code" href="types_8h.html#abba42c7929dfceb9d296535bad0c93dc">pn_proactor _t</a> *proactor);</div><div class="line"><a name="l00232"></a><span class="lineno"> 232</span> </div><div class="line"><a name="l00248"></a><span class="lineno"> 248</span> PNP_EXTERN <span class="keywordtype">void</span> <a class="code" href="group__proactor.html#ga1950236260353f82729dbb4589ef6c27">pn_proactor_release_connection</a>(<a class="code" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> *connection);</div><div class="line"><a name="l00249"></a><span class="lineno"> 249</span> </div><div class="line"><a name="l00262"></a><span class="lineno"> 262</span> PNP_EXTERN <span class="keywordtype">void</span> <a class="code" href="group__proactor.html#ga0f49c771fe3bff54f58c9d583ca30560">pn_connection_wake</a>(<a class="code" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> *connection);</div><div class="line"><a name="l00263"></a><span class="lineno"> 263</span> </div><div class= "line"><a name="l00271"></a><span class="lineno"> 271</span> PNP_EXTERN <a class="code" href="types_8h.html#abba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> *<a class="code" href="group__proactor.html#ga4727a4e26f19efcff0d48960cbba2f40">pn_connection_proactor</a>(<a class="code" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> *connection);</div><div class="line"><a name="l00272"></a><span class="lineno"> 272</span> </div><div class="line"><a name="l00280"></a><span class="lineno"> 280</span> PNP_EXTERN <a class="code" href="types_8h.html#abba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> *<a class="code" href="group__proactor.html#gac412771217decd84bd70931acbd0828a">pn_event_proactor</a>(<a class="code" href="group__event.html#ga87f3028b4888632bbd56fb71ac737ae8">pn_event_t</a> *event);</div><div class="line"><a name="l00281"></a><span class="lineno"> 281</span> </div><div class="line"><a name="l00294"></a><span class ="lineno"> 294</span> PNP_EXTERN <a class="code" href="group__api__types.html#ga9a701bc6dc9af9f42c3f4679172a723c">pn_millis_t</a> <a class="code" href="group__proactor.html#gad45b60b98f2bf385ee6ca5dca7b3f42d">pn_proactor_now</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00295"></a><span class="lineno"> 295</span> </div><div class="line"><a name="l00347"></a><span class="lineno"> 347</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00348"></a><span class="lineno"> 348</span> }</div><div class="line"><a name="l00349"></a><span class="lineno"> 349</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00350"></a><span class="lineno"> 350</span> </div><div class="line"><a name="l00351"></a><span class="lineno"> 351</span> <span class="preprocessor">#endif </span><span class="comment">/* proactor.h */</span><span class="preprocessor"></span></div> <div class="ttc" id="group__listener_html_ga68ac7072ae60612d0bca5470014bf216"><div class="ttname"><a href="group__listener.html#ga68ac7072ae60612d0bca5470014bf216">pn_listener_t</a></div><div class="ttdeci">struct pn_listener_t pn_listener_t</div><div class="ttdoc">A listener accepts connections. </div><div class="ttdef"><b>Definition:</b> types.h:409</div></div> +<a href="proactor_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#ifndef PROTON_PROACTOR_H</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define PROTON_PROACTOR_H 1</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> </div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">/*</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * or more contributor license agreements. See the NOTICE file</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</spa n> <span class="comment"> * distributed with this work for additional information</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * regarding copyright ownership. The ASF licenses this file</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * to you under the Apache License, Version 2.0 (the</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * "License"); you may not use this file except in compliance</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * with the License. You may obtain a copy of the License at</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> *</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span cl ass="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> *</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * Unless required by applicable law or agreed to in writing,</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * software distributed under the License is distributed on an</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * KIND, either express or implied. See the License for the</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * spe cific language governing permissions and limitations</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * under the License.</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> */</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <<a class="code" href="condition_8h.html">proton/condition.h</a>></span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <<a class="code" href="event_8h.html">proton/event.h</a>></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <proton/import_export.h></span></div><div class="line"><a name="l00026"></a><span class="l ineno"> 26</span> <span class="preprocessor">#include <<a class="code" href="types_8h.html">proton/types.h</a>></span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div><div class="line"><a name="l00074"></a><span class="lineno"><a class="line" href="group__proactor.html#ga29ae114b42fb797c103dc9883ebcb256"> 74</a></span> <span class="preprocessor">#define PN_MAX_ADDR 1060</span></div><div class="line"><a name="l00075"></ a><span class="lineno"> 75</span> </div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> PNP_EXTERN <span class="keywordtype">int</span> <a class="code" href="group__proactor.html#gaf67a7642c9003b36255b58776b494c96">pn_proactor_addr</a>(<span class="keywordtype">char</span> *addr, <span class="keywordtype">size_t</span> size, <span class="keyword">const</span> <span class="keywordtype">char</span> *host, <span class="keyword">const</span> <span class="keywordtype">char</span> *port);</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> </div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> PNP_EXTERN <a class="code" href="group__proactor.html#gabba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> *<a class="code" href="group__proactor.html#gac2a925b3de00efd8cd40fa9920169554">pn_proactor</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00092"></a><span class="line no"> 92</span> </div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> PNP_EXTERN <span class="keywordtype">void</span> <a class="code" href="group__proactor.html#ga5260c2653d4af5eb2f1c8c6190e9d6cf">pn_proactor_free</a>(<a class="code" href="group__proactor.html#gabba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> *proactor);</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> PNP_EXTERN <span class="keywordtype">void</span> <a class="code" href="group__proactor.html#ga9a9d1c4138226fa87160f4769b87f8e6">pn_proactor_connect</a>(<a class="code" href="group__proactor.html#gabba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> *proactor, <a class="code" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> *connection, <span class="keyword">const</span> <span class="keywordtype">char</span> *addr);</div><div c lass="line"><a name="l00120"></a><span class="lineno"> 120</span> </div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> PNP_EXTERN <span class="keywordtype">void</span> <a class="code" href="group__proactor.html#gacbed6a4ab75ef8452c10d52e4cd62752">pn_proactor_listen</a>(<a class="code" href="group__proactor.html#gabba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> *proactor, <a class="code" href="group__listener.html#ga68ac7072ae60612d0bca5470014bf216">pn_listener_t</a> *listener, <span class="keyword">const</span> <span class="keywordtype">char</span> *addr, <span class="keywordtype">int</span> backlog);</div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span> </div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span> PNP_EXTERN <span class="keywordtype">void</span> <a class="code" href="group__proactor.html#gac600bd88ed0fc6c2b66bed4a8740bd68">pn_proactor_disconnect</a>(<a class="code" href="gro up__proactor.html#gabba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> *proactor, <a class="code" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a> *condition);</div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span> </div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span> PNP_EXTERN <a class="code" href="group__event.html#ga6bc581dfeaa8e8d46d07d37229d565c9">pn_event_batch_t</a> *<a class="code" href="group__proactor.html#ga2b66a46f3e557010ec61bd105326753d">pn_proactor_wait</a>(<a class="code" href="group__proactor.html#gabba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> *proactor);</div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span> </div><div class="line"><a name="l00190"></a><span class="lineno"> 190</span> PNP_EXTERN <a class="code" href="group__event.html#ga6bc581dfeaa8e8d46d07d37229d565c9">pn_event_batch_t</a> *<a class="code" href="group__proactor.htm l#ga957eae24db6ec4962af79c5a06106115">pn_proactor_get</a>(<a class="code" href="group__proactor.html#gabba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> *proactor);</div><div class="line"><a name="l00191"></a><span class="lineno"> 191</span> </div><div class="line"><a name="l00200"></a><span class="lineno"> 200</span> PNP_EXTERN <span class="keywordtype">void</span> <a class="code" href="group__proactor.html#gade60ff2292b74841766f953b906285c0">pn_proactor_done</a>(<a class="code" href="group__proactor.html#gabba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> *proactor, <a class="code" href="group__event.html#ga6bc581dfeaa8e8d46d07d37229d565c9">pn_event_batch_t</a> *events);</div><div class="line"><a name="l00201"></a><span class="lineno"> 201</span> </div><div class="line"><a name="l00213"></a><span class="lineno"> 213</span> PNP_EXTERN <span class="keywordtype">void</span> <a class="code" href="group__proactor.html#gaa5255cd1bcb5d7f5639b53dc30712711">pn_p roactor_interrupt</a>(<a class="code" href="group__proactor.html#gabba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> *proactor);</div><div class="line"><a name="l00214"></a><span class="lineno"> 214</span> </div><div class="line"><a name="l00226"></a><span class="lineno"> 226</span> PNP_EXTERN <span class="keywordtype">void</span> <a class="code" href="group__proactor.html#gad7cd71f06282eb290699d90c316b2d32">pn_proactor_set_timeout</a>(<a class="code" href="group__proactor.html#gabba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> *proactor, <a class="code" href="group__api__types.html#ga9a701bc6dc9af9f42c3f4679172a723c">pn_millis_t</a> timeout);</div><div class="line"><a name="l00227"></a><span class="lineno"> 227</span> </div><div class="line"><a name="l00234"></a><span class="lineno"> 234</span> PNP_EXTERN <span class="keywordtype">void</span> <a class="code" href="group__proactor.html#gac206e4d0a1b7546d940a83cdd79ce93f">pn_proactor_cancel_timeout</a>(<a class="code" href="group__proactor.html#gabba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> *proactor);</div><div class="line"><a name="l00235"></a><span class="lineno"> 235</span> </div><div class="line"><a name="l00252"></a><span class="lineno"> 252</span> PNP_EXTERN <span class="keywordtype">void</span> <a class="code" href="group__proactor.html#ga1950236260353f82729dbb4589ef6c27">pn_proactor_release_connection</a>(<a class="code" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> *connection);</div><div class="line"><a name="l00253"></a><span class="lineno"> 253</span> </div><div class="line"><a name="l00266"></a><span class="lineno"> 266</span> PNP_EXTERN <span class="keywordtype">void</span> <a class="code" href="group__proactor.html#ga0f49c771fe3bff54f58c9d583ca30560">pn_connection_wake</a>(<a class="code" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> *connection);</div><div cl ass="line"><a name="l00267"></a><span class="lineno"> 267</span> </div><div class="line"><a name="l00275"></a><span class="lineno"> 275</span> PNP_EXTERN <a class="code" href="group__proactor.html#gabba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> *<a class="code" href="group__proactor.html#ga4727a4e26f19efcff0d48960cbba2f40">pn_connection_proactor</a>(<a class="code" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> *connection);</div><div class="line"><a name="l00276"></a><span class="lineno"> 276</span> </div><div class="line"><a name="l00284"></a><span class="lineno"> 284</span> PNP_EXTERN <a class="code" href="group__proactor.html#gabba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> *<a class="code" href="group__proactor.html#gac412771217decd84bd70931acbd0828a">pn_event_proactor</a>(<a class="code" href="group__event.html#ga87f3028b4888632bbd56fb71ac737ae8">pn_event_t</a> *event);</div><div class="line"><a name="l00 285"></a><span class="lineno"> 285</span> </div><div class="line"><a name="l00298"></a><span class="lineno"> 298</span> PNP_EXTERN <a class="code" href="group__api__types.html#ga9a701bc6dc9af9f42c3f4679172a723c">pn_millis_t</a> <a class="code" href="group__proactor.html#gad45b60b98f2bf385ee6ca5dca7b3f42d">pn_proactor_now</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00299"></a><span class="lineno"> 299</span> </div><div class="line"><a name="l00355"></a><span class="lineno"> 355</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00356"></a><span class="lineno"> 356</span> }</div><div class="line"><a name="l00357"></a><span class="lineno"> 357</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00358"></a><span class="lineno"> 358</span> </div><div class="line"><a name="l00359"></a><span class="lineno"> 359</span> <span class="preproces sor">#endif </span><span class="comment">/* proactor.h */</span><span class="preprocessor"></span></div><div class="ttc" id="group__listener_html_ga68ac7072ae60612d0bca5470014bf216"><div class="ttname"><a href="group__listener.html#ga68ac7072ae60612d0bca5470014bf216">pn_listener_t</a></div><div class="ttdeci">struct pn_listener_t pn_listener_t</div><div class="ttdoc">A listener for incoming connections. </div><div class="ttdef"><b>Definition:</b> types.h:422</div></div> <div class="ttc" id="group__proactor_html_gaf67a7642c9003b36255b58776b494c96"><div class="ttname"><a href="group__proactor.html#gaf67a7642c9003b36255b58776b494c96">pn_proactor_addr</a></div><div class="ttdeci">PNP_EXTERN int pn_proactor_addr(char *addr, size_t size, const char *host, const char *port)</div><div class="ttdoc">Format a host:port address string for pn_proactor_connect() or pn_proactor_listen() ...</div></div> -<div class="ttc" id="group__api__types_html_ga9a701bc6dc9af9f42c3f4679172a723c"><div class="ttname"><a href="group__api__types.html#ga9a701bc6dc9af9f42c3f4679172a723c">pn_millis_t</a></div><div class="ttdeci">uint32_t pn_millis_t</div><div class="ttdoc">A span of time in milliseconds. </div><div class="ttdef"><b>Definition:</b> types.h:135</div></div> -<div class="ttc" id="group__proactor_html_ga2b66a46f3e557010ec61bd105326753d"><div class="ttname"><a href="group__proactor.html#ga2b66a46f3e557010ec61bd105326753d">pn_proactor_wait</a></div><div class="ttdeci">PNP_EXTERN pn_event_batch_t * pn_proactor_wait(pn_proactor_t *proactor)</div><div class="ttdoc">Wait until there are Events to handle. </div></div> +<div class="ttc" id="group__api__types_html_ga9a701bc6dc9af9f42c3f4679172a723c"><div class="ttname"><a href="group__api__types.html#ga9a701bc6dc9af9f42c3f4679172a723c">pn_millis_t</a></div><div class="ttdeci">uint32_t pn_millis_t</div><div class="ttdoc">A span of time in milliseconds. </div><div class="ttdef"><b>Definition:</b> types.h:147</div></div> +<div class="ttc" id="group__proactor_html_ga2b66a46f3e557010ec61bd105326753d"><div class="ttname"><a href="group__proactor.html#ga2b66a46f3e557010ec61bd105326753d">pn_proactor_wait</a></div><div class="ttdeci">PNP_EXTERN pn_event_batch_t * pn_proactor_wait(pn_proactor_t *proactor)</div><div class="ttdoc">Wait until there are Proactor events to handle. </div></div> <div class="ttc" id="types_8h_html"><div class="ttname"><a href="types_8h.html">types.h</a></div><div class="ttdoc">AMQP and API data types. </div></div> -<div class="ttc" id="group__event_html_ga6bc581dfeaa8e8d46d07d37229d565c9"><div class="ttname"><a href="group__event.html#ga6bc581dfeaa8e8d46d07d37229d565c9">pn_event_batch_t</a></div><div class="ttdeci">struct pn_event_batch_t pn_event_batch_t</div><div class="ttdoc">Experimental - A batch of events that must be handled in sequence. </div><div class="ttdef"><b>Definition:</b> event.h:547</div></div> +<div class="ttc" id="group__event_html_ga6bc581dfeaa8e8d46d07d37229d565c9"><div class="ttname"><a href="group__event.html#ga6bc581dfeaa8e8d46d07d37229d565c9">pn_event_batch_t</a></div><div class="ttdeci">struct pn_event_batch_t pn_event_batch_t</div><div class="ttdoc">Unsettled API - A batch of events that must be handled in sequence. </div><div class="ttdef"><b>Definition:</b> event.h:547</div></div> <div class="ttc" id="group__proactor_html_gaa5255cd1bcb5d7f5639b53dc30712711"><div class="ttname"><a href="group__proactor.html#gaa5255cd1bcb5d7f5639b53dc30712711">pn_proactor_interrupt</a></div><div class="ttdeci">PNP_EXTERN void pn_proactor_interrupt(pn_proactor_t *proactor)</div><div class="ttdoc">Return a PN_PROACTOR_INTERRUPT event as soon as possible. </div></div> <div class="ttc" id="group__proactor_html_gac600bd88ed0fc6c2b66bed4a8740bd68"><div class="ttname"><a href="group__proactor.html#gac600bd88ed0fc6c2b66bed4a8740bd68">pn_proactor_disconnect</a></div><div class="ttdeci">PNP_EXTERN void pn_proactor_disconnect(pn_proactor_t *proactor, pn_condition_t *condition)</div><div class="ttdoc">Disconnect all connections and listeners belonging to the proactor. </div></div> <div class="ttc" id="group__proactor_html_gad7cd71f06282eb290699d90c316b2d32"><div class="ttname"><a href="group__proactor.html#gad7cd71f06282eb290699d90c316b2d32">pn_proactor_set_timeout</a></div><div class="ttdeci">PNP_EXTERN void pn_proactor_set_timeout(pn_proactor_t *proactor, pn_millis_t timeout)</div><div class="ttdoc">Return a PN_PROACTOR_TIMEOUT after timeout milliseconds elapse. </div></div> +<div class="ttc" id="group__proactor_html_gabba42c7929dfceb9d296535bad0c93dc"><div class="ttname"><a href="group__proactor.html#gabba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a></div><div class="ttdeci">struct pn_proactor_t pn_proactor_t</div><div class="ttdoc">A harness for multithreaded IO. </div><div class="ttdef"><b>Definition:</b> types.h:440</div></div> <div class="ttc" id="condition_8h_html"><div class="ttname"><a href="condition_8h.html">condition.h</a></div><div class="ttdoc">An endpoint error state. </div></div> <div class="ttc" id="group__proactor_html_gac412771217decd84bd70931acbd0828a"><div class="ttname"><a href="group__proactor.html#gac412771217decd84bd70931acbd0828a">pn_event_proactor</a></div><div class="ttdeci">PNP_EXTERN pn_proactor_t * pn_event_proactor(pn_event_t *event)</div><div class="ttdoc">Return the proactor associated with an event. </div></div> <div class="ttc" id="group__proactor_html_ga0f49c771fe3bff54f58c9d583ca30560"><div class="ttname"><a href="group__proactor.html#ga0f49c771fe3bff54f58c9d583ca30560">pn_connection_wake</a></div><div class="ttdeci">PNP_EXTERN void pn_connection_wake(pn_connection_t *connection)</div><div class="ttdoc">Return a PN_CONNECTION_WAKE event for connection as soon as possible. </div></div> <div class="ttc" id="group__proactor_html_ga9a9d1c4138226fa87160f4769b87f8e6"><div class="ttname"><a href="group__proactor.html#ga9a9d1c4138226fa87160f4769b87f8e6">pn_proactor_connect</a></div><div class="ttdeci">PNP_EXTERN void pn_proactor_connect(pn_proactor_t *proactor, pn_connection_t *connection, const char *addr)</div><div class="ttdoc">Bind connection to a new Transport connected to addr. </div></div> <div class="ttc" id="group__proactor_html_gacbed6a4ab75ef8452c10d52e4cd62752"><div class="ttname"><a href="group__proactor.html#gacbed6a4ab75ef8452c10d52e4cd62752">pn_proactor_listen</a></div><div class="ttdeci">PNP_EXTERN void pn_proactor_listen(pn_proactor_t *proactor, pn_listener_t *listener, const char *addr, int backlog)</div><div class="ttdoc">Start listening for incoming connections. </div></div> <div class="ttc" id="group__proactor_html_gac2a925b3de00efd8cd40fa9920169554"><div class="ttname"><a href="group__proactor.html#gac2a925b3de00efd8cd40fa9920169554">pn_proactor</a></div><div class="ttdeci">PNP_EXTERN pn_proactor_t * pn_proactor(void)</div><div class="ttdoc">Create a proactor. </div></div> -<div class="ttc" id="types_8h_html_abba42c7929dfceb9d296535bad0c93dc"><div class="ttname"><a href="types_8h.html#abba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a></div><div class="ttdeci">struct pn_proactor_t pn_proactor_t</div><div class="ttdoc">The proactor, see pn_proactor() </div><div class="ttdef"><b>Definition:</b> types.h:426</div></div> <div class="ttc" id="group__proactor_html_gad45b60b98f2bf385ee6ca5dca7b3f42d"><div class="ttname"><a href="group__proactor.html#gad45b60b98f2bf385ee6ca5dca7b3f42d">pn_proactor_now</a></div><div class="ttdeci">PNP_EXTERN pn_millis_t pn_proactor_now(void)</div><div class="ttdoc">Get the real elapsed time since an arbitrary point in the past in milliseconds. </div></div> <div class="ttc" id="group__proactor_html_gac206e4d0a1b7546d940a83cdd79ce93f"><div class="ttname"><a href="group__proactor.html#gac206e4d0a1b7546d940a83cdd79ce93f">pn_proactor_cancel_timeout</a></div><div class="ttdeci">PNP_EXTERN void pn_proactor_cancel_timeout(pn_proactor_t *proactor)</div><div class="ttdoc">Cancel the pending timeout set by pn_proactor_set_timeout(). </div></div> <div class="ttc" id="group__proactor_html_ga4727a4e26f19efcff0d48960cbba2f40"><div class="ttname"><a href="group__proactor.html#ga4727a4e26f19efcff0d48960cbba2f40">pn_connection_proactor</a></div><div class="ttdeci">PNP_EXTERN pn_proactor_t * pn_connection_proactor(pn_connection_t *connection)</div><div class="ttdoc">Return the proactor associated with a connection. </div></div> <div class="ttc" id="group__proactor_html_ga5260c2653d4af5eb2f1c8c6190e9d6cf"><div class="ttname"><a href="group__proactor.html#ga5260c2653d4af5eb2f1c8c6190e9d6cf">pn_proactor_free</a></div><div class="ttdeci">PNP_EXTERN void pn_proactor_free(pn_proactor_t *proactor)</div><div class="ttdoc">Free the proactor. </div></div> <div class="ttc" id="group__proactor_html_gade60ff2292b74841766f953b906285c0"><div class="ttname"><a href="group__proactor.html#gade60ff2292b74841766f953b906285c0">pn_proactor_done</a></div><div class="ttdeci">PNP_EXTERN void pn_proactor_done(pn_proactor_t *proactor, pn_event_batch_t *events)</div><div class="ttdoc">Call when finished handling a batch of events. </div></div> -<div class="ttc" id="group__proactor_html_ga957eae24db6ec4962af79c5a06106115"><div class="ttname"><a href="group__proactor.html#ga957eae24db6ec4962af79c5a06106115">pn_proactor_get</a></div><div class="ttdeci">PNP_EXTERN pn_event_batch_t * pn_proactor_get(pn_proactor_t *proactor)</div><div class="ttdoc">Return Events if any are available immediately. </div></div> +<div class="ttc" id="group__proactor_html_ga957eae24db6ec4962af79c5a06106115"><div class="ttname"><a href="group__proactor.html#ga957eae24db6ec4962af79c5a06106115">pn_proactor_get</a></div><div class="ttdeci">PNP_EXTERN pn_event_batch_t * pn_proactor_get(pn_proactor_t *proactor)</div><div class="ttdoc">Return Proactor events if any are available immediately. </div></div> <div class="ttc" id="event_8h_html"><div class="ttname"><a href="event_8h.html">event.h</a></div><div class="ttdoc">Protocol and transport events. </div></div> -<div class="ttc" id="group__connection_html_ga886351d81ff3a977a284a206526c5aff"><div class="ttname"><a href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a></div><div class="ttdeci">struct pn_connection_t pn_connection_t</div><div class="ttdoc">An AMQP Connection object. </div><div class="ttdef"><b>Definition:</b> types.h:271</div></div> +<div class="ttc" id="group__connection_html_ga886351d81ff3a977a284a206526c5aff"><div class="ttname"><a href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a></div><div class="ttdeci">struct pn_connection_t pn_connection_t</div><div class="ttdoc">An AMQP Connection object. </div><div class="ttdef"><b>Definition:</b> types.h:283</div></div> <div class="ttc" id="group__condition_html_ga11eb7db7d2c205169fe3d47c996a95a5"><div class="ttname"><a href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a></div><div class="ttdeci">struct pn_condition_t pn_condition_t</div><div class="ttdoc">An AMQP Condition object. </div><div class="ttdef"><b>Definition:</b> condition.h:64</div></div> <div class="ttc" id="group__proactor_html_ga1950236260353f82729dbb4589ef6c27"><div class="ttname"><a href="group__proactor.html#ga1950236260353f82729dbb4589ef6c27">pn_proactor_release_connection</a></div><div class="ttdeci">PNP_EXTERN void pn_proactor_release_connection(pn_connection_t *connection)</div><div class="ttdoc">Release ownership of connection, disassociate it from its proactor. </div></div> <div class="ttc" id="group__event_html_ga87f3028b4888632bbd56fb71ac737ae8"><div class="ttname"><a href="group__event.html#ga87f3028b4888632bbd56fb71ac737ae8">pn_event_t</a></div><div class="ttdeci">struct pn_event_t pn_event_t</div><div class="ttdoc">Notification of a state change in the protocol engine. </div><div class="ttdef"><b>Definition:</b> event.h:75</div></div> http://git-wip-us.apache.org/repos/asf/qpid-site/blob/7437c595/content/releases/qpid-proton-master/proton/c/api/sasl_8h_source.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-master/proton/c/api/sasl_8h_source.html b/content/releases/qpid-proton-master/proton/c/api/sasl_8h_source.html index b760b86..b61b3f6 100755 --- a/content/releases/qpid-proton-master/proton/c/api/sasl_8h_source.html +++ b/content/releases/qpid-proton-master/proton/c/api/sasl_8h_source.html @@ -95,7 +95,7 @@ $(document).ready(function(){initNavTree('sasl_8h_source.html','');}); <div class="contents"> <a href="sasl_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#ifndef PROTON_SASL_H</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define PROTON_SASL_H 1</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> </div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">/*</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> *</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * or more contributor license agreements. See the NOTICE file</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * distributed with this work for additional information</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * regarding copyright ownership. The ASF licenses this file</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * to you under the Apache License, Version 2.0 (the</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * "License"); you may not use this file except in compliance</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * with the License. You may obtain a copy of the License at</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment "> *</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> *</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * Unless required by applicable law or agreed to in writing,</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * software distributed under the License is distributed on an</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * KIND, either express or implied. See the License for the</span></div><di v class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * specific language governing permissions and limitations</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * under the License.</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> *</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> */</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <proton/import_export.h></span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <proton/type_compat.h></span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</s pan> <span class="preprocessor">#include <<a class="code" href="types_8h.html">proton/types.h</a>></span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div><div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="group__sasl.html#ga4d21fddba80d3f88d0529aafe12328b0"> 49</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="group__sasl.html#ga4d21fd dba80d3f88d0529aafe12328b0">pn_sasl_t</a> <a class="code" href="group__sasl.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a>;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div><div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="group__sasl.html#gad44e79f52e0669b1930689b56dfa9c3b"> 54</a></span> <span class="keyword">typedef</span> <span class="keyword">enum</span> {</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  PN_SASL_NONE = -1, </div><div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="group__sasl.html#ggad44e79f52e0669b1930689b56dfa9c3ba0050b91650a3826a090e13f57b3b941e"> 56</a></span>  <a class="code" href="group__sasl.html#ggad44e79f52e0669b1930689b56dfa9c3ba0050b91650a3826a090e13f57b3b941e">PN_SASL_OK</a> = 0, </div><div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="group__sasl.html#ggad 44e79f52e0669b1930689b56dfa9c3bac63734ecde7c8170554f6bf04f6ce64a"> 57</a></span>  <a class="code" href="group__sasl.html#ggad44e79f52e0669b1930689b56dfa9c3bac63734ecde7c8170554f6bf04f6ce64a">PN_SASL_AUTH</a> = 1, </div><div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="group__sasl.html#ggad44e79f52e0669b1930689b56dfa9c3bacd46a2fda23f674c23ed81e6076c1939"> 58</a></span>  <a class="code" href="group__sasl.html#ggad44e79f52e0669b1930689b56dfa9c3bacd46a2fda23f674c23ed81e6076c1939">PN_SASL_SYS</a> = 2, </div><div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="group__sasl.html#ggad44e79f52e0669b1930689b56dfa9c3ba03019f909ba1d98aae94437ca4bd0191"> 59</a></span>  <a class="code" href="group__sasl.html#ggad44e79f52e0669b1930689b56dfa9c3ba03019f909ba1d98aae94437ca4bd0191">PN_SASL_PERM</a> = 3, </div><div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="group__sasl.html#ggad4 4e79f52e0669b1930689b56dfa9c3baee28d2c03fa80dccf771e37aae1bcdf3"> 60</a></span>  <a class="code" href="group__sasl.html#ggad44e79f52e0669b1930689b56dfa9c3baee28d2c03fa80dccf771e37aae1bcdf3">PN_SASL_TEMP</a> = 4 </div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> } <a class="code" href="group__sasl.html#gad44e79f52e0669b1930689b56dfa9c3b">pn_sasl_outcome_t</a>;</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> PN_EXTERN <a class="code" href="group__sasl.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> *<a class="code" href="group__sasl.html#ga7968e80e2fe9360fc14cf865dd1ac21c">pn_sasl</a>(<a class="code" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport);</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div><div class="line"><a name="l00088">< /a><span class="lineno"> 88</span> PN_EXTERN <span class="keywordtype">bool</span> <a class="code" href="group__sasl.html#ga1737191972d5dded0993bf1431e71df0">pn_sasl_extended</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> PN_EXTERN <span class="keywordtype">void</span> <a class="code" href="group__sasl.html#ga0199871440c4ff89a204cc1d8a09f283">pn_sasl_done</a>(<a class="code" href="group__sasl.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> *sasl, <a class="code" href="group__sasl.html#gad44e79f52e0669b1930689b56dfa9c3b">pn_sasl_outcome_t</a> outcome);</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> </div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> PN_EXTERN <a class="code" href="group__sasl.html#gad44e79f52e0669b1930689b56dfa9c3b">pn_sasl_o utcome_t</a> <a class="code" href="group__sasl.html#ga03b6daf742db6a07bd7d03cb197aedb6">pn_sasl_outcome</a>(<a class="code" href="group__sasl.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> *sasl);</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> </div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> PN_EXTERN <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="group__sasl.html#ga700e1d505068f895383dd932af55987e">pn_sasl_get_user</a>(<a class="code" href="group__sasl.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> *sasl);</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> </div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> PN_EXTERN <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="group__sasl.html#ga895b6a957bf0c0204aaddb3ec5b9d863">pn_sasl_get_mech</a>(< a class="code" href="group__sasl.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> *sasl);</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> </div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span> PN_EXTERN <span class="keywordtype">void</span> <a class="code" href="group__sasl.html#ga73299a6a22e141e7911a739590032625">pn_sasl_allowed_mechs</a>(<a class="code" href="group__sasl.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> *sasl, <span class="keyword">const</span> <span class="keywordtype">char</span> *mechs);</div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span> </div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span> PN_EXTERN <span class="keywordtype">void</span> <a class="code" href="group__sasl.html#gaf472325bc055bb18a5a6f5ca03eda315">pn_sasl_set_allow_insecure_mechs</a>(<a class="code" href="group__sasl.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sa sl_t</a> *sasl, <span class="keywordtype">bool</span> insecure);</div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span> </div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span> PN_EXTERN <span class="keywordtype">bool</span> <a class="code" href="group__sasl.html#gac53ad15ee429b7ce9d0c598d1e347243">pn_sasl_get_allow_insecure_mechs</a>(<a class="code" href="group__sasl.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> *sasl);</div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span> </div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span> PN_EXTERN <span class="keywordtype">void</span> <a class="code" href="group__sasl.html#gad1a6932135165f0e5b7639b79ac71c56">pn_sasl_config_name</a>(<a class="code" href="group__sasl.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> *sasl, <span class="keyword">const</span> <span class="keywordtype">char</span> *name);</div><div class=" line"><a name="l00186"></a><span class="lineno"> 186</span> </div><div class="line"><a name="l00202"></a><span class="lineno"> 202</span> PN_EXTERN <span class="keywordtype">void</span> <a class="code" href="group__sasl.html#gabf4176414424ce02a4e03b4338d30521">pn_sasl_config_path</a>(<a class="code" href="group__sasl.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> *sasl, <span class="keyword">const</span> <span class="keywordtype">char</span> *path);</div><div class="line"><a name="l00203"></a><span class="lineno"> 203</span> </div><div class="line"><a name="l00208"></a><span class="lineno"> 208</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00209"></a><span class="lineno"> 209</span> }</div><div class="line"><a name="l00210"></a><span class="lineno"> 210</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00211"></a><span class="lineno"> 211</span> </div><div class="line"><a name="l00212"></a><span class="lineno"> 212</span> <span class="preprocessor">#endif </span><span class="comment">/* sasl.h */</span><span class="preprocessor"></span></div><div class="ttc" id="types_8h_html"><div class="ttname"><a href="types_8h.html">types.h</a></div><div class="ttdoc">AMQP and API data types. </div></div> <div class="ttc" id="group__sasl_html_ga73299a6a22e141e7911a739590032625"><div class="ttname"><a href="group__sasl.html#ga73299a6a22e141e7911a739590032625">pn_sasl_allowed_mechs</a></div><div class="ttdeci">void pn_sasl_allowed_mechs(pn_sasl_t *sasl, const char *mechs)</div><div class="ttdoc">SASL mechanisms that are to be considered for authentication. </div></div> -<div class="ttc" id="group__transport_html_gac26eda05f649bbf0399f3d8d78d12fa8"><div class="ttname"><a href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a></div><div class="ttdeci">struct pn_transport_t pn_transport_t</div><div class="ttdoc">An AMQP Transport object. </div><div class="ttdef"><b>Definition:</b> types.h:421</div></div> +<div class="ttc" id="group__transport_html_gac26eda05f649bbf0399f3d8d78d12fa8"><div class="ttname"><a href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a></div><div class="ttdeci">struct pn_transport_t pn_transport_t</div><div class="ttdoc">A network channel supporting an AMQP connection. </div><div class="ttdef"><b>Definition:</b> types.h:433</div></div> <div class="ttc" id="group__sasl_html_ggad44e79f52e0669b1930689b56dfa9c3bacd46a2fda23f674c23ed81e6076c1939"><div class="ttname"><a href="group__sasl.html#ggad44e79f52e0669b1930689b56dfa9c3bacd46a2fda23f674c23ed81e6076c1939">PN_SASL_SYS</a></div><div class="ttdoc">failed due to bad credentials </div><div class="ttdef"><b>Definition:</b> sasl.h:58</div></div> <div class="ttc" id="group__sasl_html_ga7968e80e2fe9360fc14cf865dd1ac21c"><div class="ttname"><a href="group__sasl.html#ga7968e80e2fe9360fc14cf865dd1ac21c">pn_sasl</a></div><div class="ttdeci">pn_sasl_t * pn_sasl(pn_transport_t *transport)</div><div class="ttdoc">Construct an Authentication and Security Layer object. </div></div> <div class="ttc" id="group__sasl_html_gaf472325bc055bb18a5a6f5ca03eda315"><div class="ttname"><a href="group__sasl.html#gaf472325bc055bb18a5a6f5ca03eda315">pn_sasl_set_allow_insecure_mechs</a></div><div class="ttdeci">void pn_sasl_set_allow_insecure_mechs(pn_sasl_t *sasl, bool insecure)</div><div class="ttdoc">Boolean to allow use of clear text authentication mechanisms. </div></div> http://git-wip-us.apache.org/repos/asf/qpid-site/blob/7437c595/content/releases/qpid-proton-master/proton/c/api/search/all_2.js ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-master/proton/c/api/search/all_2.js b/content/releases/qpid-proton-master/proton/c/api/search/all_2.js index c337d55..8545952 100755 --- a/content/releases/qpid-proton-master/proton/c/api/search/all_2.js +++ b/content/releases/qpid-proton-master/proton/c/api/search/all_2.js @@ -3,6 +3,5 @@ var searchData= ['data',['Data',['../group__data.html',1,'']]], ['delivery',['Delivery',['../group__delivery.html',1,'']]], ['delivery_2eh',['delivery.h',['../delivery_8h.html',1,'']]], - ['deprecated_20list',['Deprecated List',['../deprecated.html',1,'']]], ['disposition_2eh',['disposition.h',['../disposition_8h.html',1,'']]] ]; http://git-wip-us.apache.org/repos/asf/qpid-site/blob/7437c595/content/releases/qpid-proton-master/proton/c/api/search/all_3.js ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-master/proton/c/api/search/all_3.js b/content/releases/qpid-proton-master/proton/c/api/search/all_3.js index 3a30bbd..6e2a8d2 100755 --- a/content/releases/qpid-proton-master/proton/c/api/search/all_3.js +++ b/content/releases/qpid-proton-master/proton/c/api/search/all_3.js @@ -3,6 +3,5 @@ var searchData= ['error',['Error',['../group__error.html',1,'']]], ['error_2eh',['error.h',['../error_8h.html',1,'']]], ['event',['Event',['../group__event.html',1,'']]], - ['event_2eh',['event.h',['../event_8h.html',1,'']]], - ['events',['Events',['../group__proactor__events.html',1,'']]] + ['event_2eh',['event.h',['../event_8h.html',1,'']]] ]; http://git-wip-us.apache.org/repos/asf/qpid-site/blob/7437c595/content/releases/qpid-proton-master/proton/c/api/search/all_4.js ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-master/proton/c/api/search/all_4.js b/content/releases/qpid-proton-master/proton/c/api/search/all_4.js index 7cf7879..828a69a 100755 --- a/content/releases/qpid-proton-master/proton/c/api/search/all_4.js +++ b/content/releases/qpid-proton-master/proton/c/api/search/all_4.js @@ -1,4 +1,6 @@ var searchData= [ - ['introduction',['Introduction',['../index.html',1,'']]] + ['introduction',['Introduction',['../index.html',1,'']]], + ['io',['IO',['../group__io.html',1,'']]], + ['io_20integration',['IO integration',['../io_page.html',1,'']]] ]; --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@qpid.apache.org For additional commands, e-mail: commits-h...@qpid.apache.org