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.
typedef struct _VortexEventMask	VortexEventMask
	A type definition that allows to define a set of events that are ignored on a particular context.
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
VortexChannel *	vortex_event_get_channel (VortexEvent *event)
	Allows to get the channel reference or NULL if it fails.
VortexConnection *	vortex_event_get_conn (VortexEvent *event)
	Allows to get the connection reference associated to the event.
VortexCtx *	vortex_event_get_ctx (VortexEvent *event)
	Allows to get the context reference where the event was reported.
VortexEncoding	vortex_event_get_encoding (VortexEvent *event)
	Allows to get the profile encoding defined on the channel start request received (VORTEX_EVENT_CHANNEL_START).
VortexFrame *	vortex_event_get_frame (VortexEvent *event)
	Allows to get the frame reference or NULL if it fails.
int	vortex_event_get_msgno (VortexEvent *event)
	Allows to get the msgno value configured on the provided event.
const char *	vortex_event_get_name (VortexEventType event_type)
	Allows to get an unique constant string that represents this event.
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).
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).
VortexEventType	vortex_event_get_type (VortexEvent *event)
	Allows to get event type from the provided VortexEvent reference.
void	vortex_event_mask_add (VortexEventMask *mask, int events)
	Allows to configure a new event to blocked by the mask reference provided.
void	vortex_event_mask_enable (VortexEventMask *mask, axl_bool enable)
	Allows to enable/disable the provided mask.
void	vortex_event_mask_free (VortexEventMask *mask)
	Release resources allocated pointed by the mask reference.
axl_bool	vortex_event_mask_is_set (VortexEventMask *mask, VortexEventType event)
	Allows to check if an event is configred in the provided mask.
VortexEventMask *	vortex_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.
void	vortex_event_mask_remove (VortexEventMask *mask, int events)
	Allows to remove an event from the mask provided.
axl_bool	vortex_event_ref (VortexEvent *event)
	Allows to increase the reference counting associated to the event.
void	vortex_event_unref (VortexEvent *event)
	Allows to reduce the reference counting on the provided VortexEvent instance.
void	vortex_pull_cleanup (VortexCtx *ctx)
	Allows to uninstall pull API and to cleanup all allocated resources.
axl_bool	vortex_pull_init (VortexCtx *ctx)
	Activates the pull based event notification.
VortexEvent *	vortex_pull_next_event (VortexCtx *ctx, int milliseconds_to_wait)
	Allows to get next pending event.
axl_bool	vortex_pull_pending_events (VortexCtx *ctx)
	Allows to check if there are pending events in the queue.
int	vortex_pull_pending_events_num (VortexCtx *ctx)
	Allows to get the number of pending events to be read.
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).