proton  0
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Typedefs | Enumerations | Functions
event.h File Reference

Event API for the proton Engine. More...

#include <proton/import_export.h>
#include <proton/type_compat.h>
#include <stddef.h>
#include <sys/types.h>

Go to the source code of this file.

Typedefs

typedef struct pn_event_t pn_event_t
 An event provides notification of a state change within the protocol engine's object model. More...
 

Enumerations

enum  pn_event_category_t { PN_EVENT_CATEGORY_NONE = 0, PN_EVENT_CATEGORY_PROTOCOL = 0x00010000, PN_EVENT_CATEGORY_COUNT = 2 }
 Related events are grouped into categories. More...
 
enum  pn_event_type_t {
  PN_EVENT_NONE = 0, PN_CONNECTION_REMOTE_STATE = PN_EVENT_CATEGORY_PROTOCOL+1, PN_CONNECTION_LOCAL_STATE = PN_EVENT_CATEGORY_PROTOCOL+2, PN_SESSION_REMOTE_STATE = PN_EVENT_CATEGORY_PROTOCOL+3,
  PN_SESSION_LOCAL_STATE = PN_EVENT_CATEGORY_PROTOCOL+4, PN_LINK_REMOTE_STATE = PN_EVENT_CATEGORY_PROTOCOL+5, PN_LINK_LOCAL_STATE = PN_EVENT_CATEGORY_PROTOCOL+6, PN_LINK_FLOW = PN_EVENT_CATEGORY_PROTOCOL+7,
  PN_DELIVERY = PN_EVENT_CATEGORY_PROTOCOL+8, PN_TRANSPORT = PN_EVENT_CATEGORY_PROTOCOL+9
}
 An event type. More...
 

Functions

PN_EXTERN const char * pn_event_type_name (pn_event_type_t type)
 Get a human readable name for an event type. More...
 
PN_EXTERN pn_collector_tpn_collector (void)
 Construct a collector. More...
 
PN_EXTERN void pn_collector_free (pn_collector_t *collector)
 Free a collector. More...
 
PN_EXTERN pn_event_tpn_collector_peek (pn_collector_t *collector)
 Access the head event contained by a collector. More...
 
PN_EXTERN bool pn_collector_pop (pn_collector_t *collector)
 Clear the head event on a collector. More...
 
PN_EXTERN pn_event_type_t pn_event_type (pn_event_t *event)
 Get the type of an event. More...
 
PN_EXTERN pn_event_category_t pn_event_category (pn_event_t *event)
 Get the category an event belongs to. More...
 
PN_EXTERN pn_connection_tpn_event_connection (pn_event_t *event)
 Get the connection associated with an event. More...
 
PN_EXTERN pn_session_tpn_event_session (pn_event_t *event)
 Get the session associated with an event. More...
 
PN_EXTERN pn_link_tpn_event_link (pn_event_t *event)
 Get the link associated with an event. More...
 
PN_EXTERN pn_delivery_tpn_event_delivery (pn_event_t *event)
 Get the delivery associated with an event. More...
 
PN_EXTERN pn_transport_tpn_event_transport (pn_event_t *event)
 Get the transport associated with an event. More...
 

Detailed Description

Event API for the proton Engine.