Typedefs | Enumerations | Functions
Vortex PULL API: A pull API suited for singled threaded or event driven environments

Typedefs

typedef struct _VortexEvent VortexEvent
 Type representation for an event notification from the PULL API. More...
 
typedef struct _VortexEventMask VortexEventMask
 A type definition that allows to define a set of events that are ignored on a particular context. More...
 

Enumerations

enum  VortexEventType {
  VORTEX_EVENT_UNKNOWN = 0, VORTEX_EVENT_FRAME_RECEIVED = 1 << 0, VORTEX_EVENT_CHANNEL_CLOSE = 1 << 1, VORTEX_EVENT_CHANNEL_ADDED = 1 << 2,
  VORTEX_EVENT_CHANNEL_REMOVED = 1 << 3, VORTEX_EVENT_CONNECTION_CLOSED = 1 << 4, VORTEX_EVENT_CONNECTION_ACCEPTED = 1 << 5, VORTEX_EVENT_CHANNEL_START = 1 << 6,
  VORTEX_EVENT_CONNECTION_READY = 1 << 7
}
 List of events that can happen/pulled from the vortex pull API. More...
 

Functions

VortexChannelvortex_event_get_channel (VortexEvent *event)
 Allows to get the channel reference or NULL if it fails. More...
 
VortexConnectionvortex_event_get_conn (VortexEvent *event)
 Allows to get the connection reference associated to the event. More...
 
VortexCtxvortex_event_get_ctx (VortexEvent *event)
 Allows to get the context reference where the event was reported. More...
 
VortexEncoding vortex_event_get_encoding (VortexEvent *event)
 Allows to get the profile encoding defined on the channel start request received (VORTEX_EVENT_CHANNEL_START). More...
 
VortexFramevortex_event_get_frame (VortexEvent *event)
 Allows to get the frame reference or NULL if it fails. More...
 
int vortex_event_get_msgno (VortexEvent *event)
 Allows to get the msgno value configured on the provided event. More...
 
const char * vortex_event_get_name (VortexEventType event_type)
 Allows to get an unique constant string that represents this event. More...
 
const char * vortex_event_get_profile_content (VortexEvent *event)
 Allows to get the profile content defined on the channel start request received (VORTEX_EVENT_CHANNEL_START). More...
 
const char * vortex_event_get_server_name (VortexEvent *event)
 Allows to get the serverName value defined on the channel start request received (VORTEX_EVENT_CHANNEL_START). More...
 
VortexEventType vortex_event_get_type (VortexEvent *event)
 Allows to get event type from the provided VortexEvent reference. More...
 
void vortex_event_mask_add (VortexEventMask *mask, int events)
 Allows to configure a new event to blocked by the mask reference provided. More...
 
void vortex_event_mask_enable (VortexEventMask *mask, axl_bool enable)
 Allows to enable/disable the provided mask. More...
 
void vortex_event_mask_free (VortexEventMask *mask)
 Release resources allocated pointed by the mask reference. More...
 
axl_bool vortex_event_mask_is_set (VortexEventMask *mask, VortexEventType event)
 Allows to check if an event is configred in the provided mask. More...
 
VortexEventMaskvortex_event_mask_new (const char *identifier, int initial_mask, axl_bool initial_state)
 Allows to create a mask with the provided identifier, initial event mask and an initial activation state. More...
 
void vortex_event_mask_remove (VortexEventMask *mask, int events)
 Allows to remove an event from the mask provided. More...
 
axl_bool vortex_event_ref (VortexEvent *event)
 Allows to increase the reference counting associated to the event. More...
 
void vortex_event_unref (VortexEvent *event)
 Allows to reduce the reference counting on the provided VortexEvent instance. More...
 
void vortex_pull_cleanup (VortexCtx *ctx)
 Allows to uninstall pull API and to cleanup all allocated resources. More...
 
axl_bool vortex_pull_init (VortexCtx *ctx)
 Activates the pull based event notification. More...
 
VortexEventvortex_pull_next_event (VortexCtx *ctx, int milliseconds_to_wait)
 Allows to get next pending event. More...
 
axl_bool vortex_pull_pending_events (VortexCtx *ctx)
 Allows to check if there are pending events in the queue. More...
 
int vortex_pull_pending_events_num (VortexCtx *ctx)
 Allows to get the number of pending events to be read. More...
 
axl_bool vortex_pull_set_event_mask (VortexCtx *ctx, VortexEventMask *mask, axlError **error)
 Allows to install the provided event mask (VortexEventMask) on the selected context (VortexCtx). More...
 

Detailed Description