List of events that can happen/pulled from the vortex pull API.

This list not only describes the event but also provides a reference of all references that are associated to a particular event.

For example, the VORTEX_EVENT_FRAME_RECEIVED signals that a frame has arrive and a call to vortex_event_get_frame will return a reference to the frame. Not all events has all references defined.

There are a list of references that is always defined. They are assumed implicitly:

Enumerator
VORTEX_EVENT_UNKNOWN 

Undefined event.

This type is used to report errors found while using pull API.

VORTEX_EVENT_FRAME_RECEIVED 

Even type that represents a frame received.

You must call to vortex_pull_get_frame to get the reference to the frame received.

This event has the following especific references defined:

VORTEX_EVENT_CHANNEL_CLOSE 

This event signals that a channel close request has been received.

The peer must respond to the close request as soon as possible since the block channel 0 for futher operations.

This event has the following especific references defined:

With these values, the close request must be replied by using the function vortex_channel_notify_close.

VORTEX_EVENT_CHANNEL_ADDED 

Event used to signal that a channel has been added to a connection.

This happens when a channel is created.

This event has the following especific references defined:

VORTEX_EVENT_CHANNEL_REMOVED 

Event used to signal that a channel has been removed to a connection.

This happens when a channel is closed

This event has the following especific references defined:

Note the connection associated to the channel may be null due to vortex engine function. Vortex engine nullify the connection reference if its found nobody owns a reference. This way it is avoided providing a pointer to trash on the event (and vortex handlers).

VORTEX_EVENT_CONNECTION_CLOSED 

Event notification that a particular connection has been closed.

This event is also useful to detect connection broken.

This event has no especific references. It only has vortex_event_get_conn defined.

VORTEX_EVENT_CONNECTION_ACCEPTED 

Event notificaiton that a new incoming connection has been accepted due to a listener started (vortex_listener_new or similar).

Noce that this event is generated before starting the beep greeting process so the connection is still not ready. This event is emited to provided an early notification method to reject a connection or to init some particular data associated to the connection.

See also VORTEX_EVENT_CONNECTION_READY.

VORTEX_EVENT_CHANNEL_START 

Event notification to signal that a channel start request has been received.

This event has the following espefic references defined:

With these values the channel start request must be replied by accepting or denying the channel by using vortex_channel_notify_start.

VORTEX_EVENT_CONNECTION_READY 

Event notification to signal that a new BEEP connection was successfully accepted (notifies when a connection is ready to use or its setup is ready, like listeners connection).

This event is emitted after the BEEP greetings takes place. At the listener side is received when a BEEP connection was successfully accepted. Note it is received twice in the case TLS is enabled after this event (this is because a new connection is created).

A BEEP client receives this event just after completing connection new operation.

Note that this event is also fired when a listener connection is created with vortex_listener_new (or similar) and this listener connection is ready.