qpid-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From g...@apache.org
Subject [04/50] [abbrv] qpid-proton git commit: added missing doxygen for new transport events
Date Fri, 14 Nov 2014 11:03:13 GMT
added missing doxygen for new transport events

git-svn-id: https://svn.apache.org/repos/asf/qpid/proton/trunk@1628669 13f79535-47bb-0310-9956-ffa450edef68


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

Branch: refs/heads/examples
Commit: ebdf51e41467a5d2a3e1a1615393bec395b00f15
Parents: 53b034c
Author: Rafael H. Schloming <rhs@apache.org>
Authored: Wed Oct 1 10:13:46 2014 +0000
Committer: Rafael H. Schloming <rhs@apache.org>
Committed: Wed Oct 1 10:13:46 2014 +0000

----------------------------------------------------------------------
 proton-c/include/proton/event.h | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/ebdf51e4/proton-c/include/proton/event.h
----------------------------------------------------------------------
diff --git a/proton-c/include/proton/event.h b/proton-c/include/proton/event.h
index 7473132..97095c6 100644
--- a/proton-c/include/proton/event.h
+++ b/proton-c/include/proton/event.h
@@ -238,12 +238,31 @@ typedef enum {
    */
   PN_TRANSPORT,
 
+  /**
+   * Indicates that a transport error has occurred. Use
+   * ::pn_transport_condition() to access the details of the error
+   * from the associated transport.
+   */
   PN_TRANSPORT_ERROR,
 
+  /**
+   * Indicates that the head of the transport has been closed. This
+   * means the transport will never produce more bytes for output to
+   * the network. Events of this type point to the relevant transport.
+   */
   PN_TRANSPORT_HEAD_CLOSED,
 
+  /**
+   * Indicates that the tail of the transport has been closed. This
+   * means the transport will never be able to process more bytes from
+   * the network. Events of this type point to the relevant transport.
+   */
   PN_TRANSPORT_TAIL_CLOSED,
 
+  /**
+   * Indicates that the both the head and tail of the transport are
+   * closed. Events of this type point to the relevant transport.
+   */
   PN_TRANSPORT_CLOSED
 
 } pn_event_type_t;


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


Mime
View raw message