Typedefs
Vortex Handlers: Handlers used across Vortex Library for async notifications.

Typedefs

typedef void(* VortexAsyncQueueForeach )(VortexAsyncQueue *queue, axlPointer item_stored, int position, axlPointer user_data)
 Handler definition used by vortex_async_queue_foreach to implement a foreach operation over all items inside the provided queue, blocking its access during its process. More...
 
typedef int(* VortexChannelFrameSize )(VortexChannel *channel, int next_seq_no, int message_size, int max_seq_no, axlPointer user_data)
 Handler definition for the set of functions that allow the users space to control how frames are splited by the vortex sequencer process. More...
 
typedef VortexChannel *(* VortexChannelPoolCreate )(VortexConnection *connection, int channel_num, const char *profile, VortexOnCloseChannel on_close, axlPointer on_close_user_data, VortexOnFrameReceived on_received, axlPointer on_received_user_data, axlPointer create_channel_user_data, axlPointer get_next_data)
 Synchronous handler definition used by the channel pool module to create a new channel. More...
 
typedef axl_bool(* VortexChannelSelector )(VortexChannel *channel, axlPointer user_data)
 Handler used by vortex_connection_get_channel_by_func which is called to check if the channel provided must be returned as selected. More...
 
typedef int(* VortexConnectionAction )(VortexCtx *ctx, VortexConnection *conn, VortexConnection **new_conn, VortexConnectionStage stage, axlPointer user_data)
 Handler definition for the set of functions that are called during the connection creation and configured by vortex_connection_set_connection_actions. More...
 
typedef void(* VortexConnectionNew )(VortexConnection *connection, axlPointer user_data)
 Async notification for connection creation process. More...
 
typedef void(* VortexConnectionOnChannelUpdate )(VortexChannel *channel, axlPointer user_data)
 Handler definition used to notify that a channel was added or removed from a particular connection. More...
 
typedef void(* VortexConnectionOnClose )(VortexConnection *connection)
 Allows to set a handler that will be called when a connection is about being closed. More...
 
typedef void(* VortexConnectionOnCloseFull )(VortexConnection *connection, axlPointer data)
 Extended version for VortexConnectionOnClose, which also supports passing an user defined data. More...
 
typedef void(* VortexConnectionOnPreRead )(VortexConnection *connection)
 Pre read handler definition. More...
 
typedef void(* VortexIdleHandler )(VortexCtx *ctx, VortexConnection *conn, axlPointer user_data, axlPointer user_data2)
 Handler called to notify idle state reached for a particular connection. More...
 
typedef axl_bool(* VortexIoAddToFdGroup )(int fds, VortexConnection *connection, axlPointer fd_group)
 IO handler definition to perform the "add to" the fd set operation. More...
 
typedef void(* VortexIoClearFdGroup )(axlPointer fd_set)
 IO handler definition to allow defining the method to be invoked while clearing a fd set. More...
 
typedef axlPointer(* VortexIoCreateFdGroup )(VortexCtx *ctx, VortexIoWaitingFor wait_to)
 IO handler definition to allow defining the method to be invoked while createing a new fd set. More...
 
typedef void(* VortexIoDestroyFdGroup )(axlPointer fd_set)
 IO handler definition to allow defining the method to be invoked while destroying a fd set. More...
 
typedef void(* VortexIoDispatch )(axlPointer fd_group, VortexIoDispatchFunc dispatch_func, int changed, axlPointer user_data)
 Handler definition for the automatic dispatch implementation for the particular I/O mechanism selected. More...
 
typedef void(* VortexIoDispatchFunc )(int fds, VortexIoWaitingFor wait_to, VortexConnection *connection, axlPointer user_data)
 User space handler to implement automatic dispatch for I/O waiting mechanism implemented at vortex io module. More...
 
typedef axl_bool(* VortexIoHaveDispatch )(axlPointer fd_group)
 Handler definition to allow implementing the have dispatch function at the vortex io module. More...
 
typedef axl_bool(* VortexIoIsSetFdGroup )(int fds, axlPointer fd_group, axlPointer user_data)
 IO handler definition to perform the "is set" the fd set operation. More...
 
typedef int(* VortexIoWaitOnFdGroup )(axlPointer fd_group, int max_fds, VortexIoWaitingFor wait_to)
 IO handler definition to allow defining the method to be used while performing a IO blocking wait, by default implemented by the IO "select" call. More...
 
typedef void(* VortexListenerReady )(char *host, int port, VortexStatus status, char *message, axlPointer user_data)
 Async notification for listener creation. More...
 
typedef void(* VortexListenerReadyFull )(char *host, int port, VortexStatus status, char *message, VortexConnection *connection, axlPointer user_data)
 Async notification for listener creation, similar to VortexListenerReady but providing the reference for the VortexConnection created (representing the listener created). More...
 
typedef void(* VortexLogHandler )(const char *file, int line, VortexDebugLevel log_level, const char *message, va_list args)
 Handler definition that allows a client to print log messages itself. More...
 
typedef void(* VortexLogHandlerFull )(VortexCtx *ctx, const char *file, int line, VortexDebugLevel log_level, const char *message, axlPointer user_data, va_list args)
 Handler definition that allows a client to print log messages itself. More...
 
typedef axl_bool(* VortexOnAcceptedConnection )(VortexConnection *connection, axlPointer data)
 Async handler definition to get a notification for connections created at the server side (peer that is able to accept incoming connections). More...
 
typedef void(* VortexOnChannelCreated )(int channel_num, VortexChannel *channel, VortexConnection *conn, axlPointer user_data)
 Async notifier for channel creation process. More...
 
typedef void(* VortexOnChannelPoolCreated )(VortexChannelPool *pool, axlPointer user_data)
 Async notifier for Vortex Channel Pool creation. More...
 
typedef axl_bool(* VortexOnCloseChannel )(int channel_num, VortexConnection *connection, axlPointer user_data)
 Async notification for incoming close channel request. More...
 
typedef void(* VortexOnClosedChannel )(VortexChannel *channel, axlPointer user_data)
 Handler definition that allows to get a notification that the channel is being disconnected from the connection (because the connection is closed and in process of being deallocated). More...
 
typedef void(* VortexOnClosedNotification )(int channel_num, axl_bool was_closed, const char *code, const char *msg)
 Async notifier for the channel close process. More...
 
typedef void(* VortexOnClosedNotificationFull )(VortexConnection *connection, int channel_num, axl_bool was_closed, const char *code, const char *msg, axlPointer user_data)
 Async notifier for the channel close process, with support for a user defined data. More...
 
typedef void(* VortexOnFinishHandler )(VortexCtx *ctx, axlPointer user_data)
 Handler used by vortex_ctx_set_on_finish which is called when the vortex reader process detects no more pending connections are available to be watched which is a signal that no more pending work is available. More...
 
typedef void(* VortexOnFrameReceived )(VortexChannel *channel, VortexConnection *connection, VortexFrame *frame, axlPointer user_data)
 Async notifier for frame received event. More...
 
typedef void(* VortexOnNotifyCloseChannel )(VortexChannel *channel, int msg_no, axlPointer user_data)
 Async notification for incoming close channel requests. More...
 
typedef axl_bool(* VortexOnStartChannel )(int channel_num, VortexConnection *connection, axlPointer user_data)
 Async notification for start channel message received for a given profile. More...
 
typedef axl_bool(* VortexOnStartChannelExtended )(const char *profile, int channel_num, VortexConnection *connection, const char *serverName, const char *profile_content, char **profile_content_reply, VortexEncoding encoding, axlPointer user_data)
 Channel start message received handler with support for extended attributes. More...
 
typedef void(* VortexPayloadFeederFinishedHandler )(VortexChannel *channel, VortexPayloadFeeder *feeder, axlPointer user_data)
 Optional handler definition that allows to get a notification when a feeder has finished sending. More...
 
typedef axl_bool(* VortexPayloadFeederHandler )(VortexCtx *ctx, VortexPayloadFeederOp op_type, VortexPayloadFeeder *feeder, axlPointer param1, axlPointer param2, axlPointer user_data)
 Function used to retrieve content to be send when required by vortex sequencer. More...
 
typedef int(* VortexPortShareHandler )(VortexCtx *ctx, VortexConnection *listener, VortexConnection *conn, VORTEX_SOCKET _session, const char *bytes, axlPointer user_data)
 Port sharing handler definition used by those functions that tries to detect alternative transports that must be activated before continue with normal BEEP course. More...
 
typedef axl_bool(* VortexProfileMaskFunc )(VortexConnection *connection, int channel_num, const char *uri, const char *profile_content, VortexEncoding encoding, const char *serverName, VortexFrame *frame, char **error_msg, axlPointer user_data)
 Profile mask handler used to perform profile filtering functions. More...
 
typedef int(* VortexReceiveHandler )(VortexConnection *connection, char *buffer, int buffer_len)
 Defines the readers handlers used to actually received data from the underlying socket descriptor. More...
 
typedef int(* VortexSendHandler )(VortexConnection *connection, const char *buffer, int buffer_len)
 Defines the writers handlers used to actually send data through the underlaying socket descriptor. More...
 
typedef axl_bool(* VortexThreadAsyncEvent )(VortexCtx *ctx, axlPointer user_data, axlPointer user_data2)
 Handler used by async event handlers activated via vortex_thread_pool_new_event, which causes the handler definition to be called at the provided milliseconds period. More...
 
typedef axl_bool(* VortexThreadCreateFunc )(VortexThread *thread_def, VortexThreadFunc func, axlPointer user_data, va_list args)
 Handler used by Vortex library to create a new thread. More...
 
typedef axl_bool(* VortexThreadDestroyFunc )(VortexThread *thread_def, axl_bool free_data)
 Handler used by Vortex Library to release a thread's resources. More...
 

Detailed Description