qpid-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From acon...@apache.org
Subject qpid-proton git commit: NO-JIRA: Clarify doc comment for pn_proactor_listen() [Forced Update!]
Date Mon, 02 Oct 2017 18:36:07 GMT
Repository: qpid-proton
Updated Branches:
  refs/heads/master 6bdfe39a1 -> f40577175 (forced update)


NO-JIRA: Clarify doc comment for pn_proactor_listen()


Project: http://git-wip-us.apache.org/repos/asf/qpid-proton/repo
Commit: http://git-wip-us.apache.org/repos/asf/qpid-proton/commit/f4057717
Tree: http://git-wip-us.apache.org/repos/asf/qpid-proton/tree/f4057717
Diff: http://git-wip-us.apache.org/repos/asf/qpid-proton/diff/f4057717

Branch: refs/heads/master
Commit: f405771755585e7f265d549d2f6b29a3052a7ba5
Parents: 9729f3b
Author: Alan Conway <aconway@redhat.com>
Authored: Mon Oct 2 10:30:22 2017 -0400
Committer: Alan Conway <aconway@redhat.com>
Committed: Mon Oct 2 14:35:58 2017 -0400

----------------------------------------------------------------------
 proton-c/include/proton/proactor.h | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/f4057717/proton-c/include/proton/proactor.h
----------------------------------------------------------------------
diff --git a/proton-c/include/proton/proactor.h b/proton-c/include/proton/proactor.h
index e878df2..414883a 100644
--- a/proton-c/include/proton/proactor.h
+++ b/proton-c/include/proton/proactor.h
@@ -120,7 +120,13 @@ PNP_EXTERN void pn_proactor_connect(pn_proactor_t *proactor, pn_connection_t
*co
 
 /**
  * Start listening for incoming connections.
- * Errors are returned as @ref proactor_events by pn_proactor_wait().
+ *
+ * pn_proactor_wait() will return a @ref PN_LISTENER_OPEN event when the
+ * listener is ready to accept connections, or if the listen operation fails.
+ * If the listen operation failed, then pn_listener_condition() will be set.
+ *
+ * When the listener is closed by pn_listener_close(), or because of an error, a
+ * PN_LISTENER_CLOSE event will be returned and pn_listener_condition() will be set.
  *
  * @note Thread-safe
  *
@@ -133,7 +139,7 @@ PNP_EXTERN void pn_proactor_connect(pn_proactor_t *proactor, pn_connection_t
*co
  * @param[in] addr the "host:port" network address, constructed by pn_proactor_addr()
  * An empty host will listen for all protocols (IPV6 and IPV4) on all local interfaces.
  * An empty port will listen on the standard AMQP port (5672).
-
+ *
  * @param[in] backlog of un-handled connection requests to allow before refusing
  * connections. If @p addr resolves to multiple interface/protocol combinations,
  * the backlog applies to each separately.


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


Mime
View raw message