qpid-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From acon...@apache.org
Subject [1/2] qpid-proton git commit: NO-JIRA: Clarify doc comment for pn_proactor_listen()
Date Mon, 02 Oct 2017 14:32:58 GMT
Repository: qpid-proton
Updated Branches:
  refs/heads/master 732961703 -> 6bdfe39a1


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/6bdfe39a
Tree: http://git-wip-us.apache.org/repos/asf/qpid-proton/tree/6bdfe39a
Diff: http://git-wip-us.apache.org/repos/asf/qpid-proton/diff/6bdfe39a

Branch: refs/heads/master
Commit: 6bdfe39a18b81d10da5393af37c8f12051d94e02
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 10:30:50 2017 -0400

----------------------------------------------------------------------
 proton-c/include/proton/proactor.h | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/6bdfe39a/proton-c/include/proton/proactor.h
----------------------------------------------------------------------
diff --git a/proton-c/include/proton/proactor.h b/proton-c/include/proton/proactor.h
index e878df2..2733c6c 100644
--- a/proton-c/include/proton/proactor.h
+++ b/proton-c/include/proton/proactor.h
@@ -120,7 +120,12 @@ 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().
+ *
+ * When the listener is ready, a @ref PN_LISTENER_OPEN event will be returned by
+ * pn_proactor_wait().  If 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 have information about the error if there was
+ * one.
  *
  * @note Thread-safe
  *


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


Mime
View raw message