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.
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.
typedef VortexChannel *(* VortexChannelPoolCreate )(VortexConnection *connection, int channel_num, char *profile, VortexOnCloseChannel on_close, axlPointer on_close_user_data, VortexOnFrameReceived on_received, axlPointer on_received_user_data, axlPointer create_channel_user_data)
 Synchronous handler definition used by the channel pool module to create a new channel.
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.
typedef void(* VortexConnectionNew )(VortexConnection *connection, axlPointer user_data)
 Async notification for connection creation process.
typedef void(* VortexConnectionNotifyNew )(VortexConnection *created, axlPointer user_data)
 Handler definition for the set of functions that are called once a connection is created.
typedef void(* VortexConnectionOnChannelUpdate )(VortexChannel *channel, axlPointer user_data)
 Handler definition used to notify that a channel was added or removed from a particular connection.
typedef void(* VortexConnectionOnClose )(VortexConnection *connection)
 Allows to set a handler that will be called when a connection is about being closed.
typedef void(* VortexConnectionOnCloseFull )(VortexConnection *connection, axlPointer data)
 Extended version for VortexConnectionOnClose, which also supports passing an user defined data.
typedef void(* VortexConnectionOnPreRead )(VortexConnection *connection)
 Pre read handler definition.
typedef axl_bool(* VortexIoAddToFdGroup )(int fds, VortexConnection *connection, axlPointer fd_group)
 IO handler definition to perform the "add to" the fd set operation.
typedef void(* VortexIoClearFdGroup )(axlPointer fd_set)
 IO handler definition to allow defining the method to be invoked while clearing a fd set.
typedef axlPointer(* VortexIoCreateFdGroup )(VortexIoWaitingFor wait_to)
 IO handler definition to allow defining the method to be invoked while createing a new fd set.
typedef void(* VortexIoDestroyFdGroup )(axlPointer fd_set)
 IO handler definition to allow defining the method to be invoked while destroying a fd set.
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.
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.
typedef axl_bool(* VortexIoHaveDispatch )(axlPointer fd_group)
 Handler definition to allow implementing the have dispatch function at the vortex io module.
typedef axl_bool(* VortexIoIsSetFdGroup )(int fds, axlPointer fd_group, axlPointer user_data)
 IO handler definition to perform the "is set" the fd set operation.
typedef axl_bool(* 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.
typedef void(* VortexListenerReady )(char *host, int port, VortexStatus status, char *message, axlPointer user_data)
 Async notification for listener creation.
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).
typedef void(* VortexLogHandler )(const char *domain, VortexDebugLevel log_level, const char *message, va_list args)
 Handler definition that allows a client to print log messages itself.
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).
typedef void(* VortexOnChannelCreated )(int channel_num, VortexChannel *channel, axlPointer user_data)
 Async notifier for channel creation process.
typedef void(* VortexOnChannelPoolCreated )(VortexChannelPool *pool, axlPointer user_data)
 Async notifier for Vortex Channel Pool creation.
typedef axl_bool(* VortexOnCloseChannel )(int channel_num, VortexConnection *connection, axlPointer user_data)
 Async notification for incoming close channel request.
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).
typedef void(* VortexOnClosedNotification )(int channel_num, axl_bool was_closed, const char *code, const char *msg)
 Async notifier for the channel close process.
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.
typedef void(* VortexOnFrameReceived )(VortexChannel *channel, VortexConnection *connection, VortexFrame *frame, axlPointer user_data)
 Async notifier for frame received event.
typedef void(* VortexOnNotifyCloseChannel )(VortexChannel *channel, int msg_no, axlPointer user_data)
 Async notification for incoming close channel requests.
typedef axl_bool(* VortexOnStartChannel )(int channel_num, VortexConnection *connection, axlPointer user_data)
 Async notification for start channel message received for a given profile.
typedef axl_bool(* VortexOnStartChannelExtended )(char *profile, int channel_num, VortexConnection *connection, char *serverName, char *profile_content, char **profile_content_reply, VortexEncoding encoding, axlPointer user_data)
 Channel start message received handler with support for extended attributes.
typedef axl_bool(* VortexProfileMaskFunc )(VortexConnection *connection, int channel_num, const char *uri, const char *profile_content, const char *serverName, axlPointer user_data)
 Profile mask handler to perform profile filtering functions.
typedef int(* VortexReceiveHandler )(VortexConnection *connection, char *buffer, int buffer_len)
 Defines the readers handlers used to actually received data from the underlying socket descriptor.
typedef axl_bool(* VortexSaslAuthAnonymous )(VortexConnection *connection, const char *anonymous_token)
 Asynchronous notification to enable user space to accept or deny anonymous authentication for SASL ANONYMOUS profile.
typedef axl_bool(* VortexSaslAuthAnonymousFull )(VortexConnection *connection, const char *anonymous_token, axlPointer user_data)
 Asynchronous notification to enable user space to accept or deny anonymous authentication for SASL ANONYMOUS profile.
typedef char *(* VortexSaslAuthCramMd5 )(VortexConnection *connection, const char *auth_id)
 Asynchronous notification to enable user space code to validate SASL CRAM MD5 request received.
typedef char *(* VortexSaslAuthCramMd5Full )(VortexConnection *connection, const char *auth_id, axlPointer user_data)
 Asynchronous notification to enable user space code to validate SASL CRAM MD5 request received.
typedef char *(* VortexSaslAuthDigestMd5 )(VortexConnection *connection, const char *auth_id, const char *authorization_id, const char *realm)
 Asynchronous notification to enable user space to validate SASL DIGEST MD5 received requests.
typedef char *(* VortexSaslAuthDigestMd5Full )(VortexConnection *connection, const char *auth_id, const char *authorization_id, const char *realm, axlPointer user_data)
 Asynchronous notification to enable user space to validate SASL DIGEST MD5 received requests.
typedef axl_bool(* VortexSaslAuthExternal )(VortexConnection *connection, const char *authorization_id)
 Asynchronous notification to enable user space to accept or deny authentication for SASL EXTERNAL profile.
typedef axl_bool(* VortexSaslAuthExternalFull )(VortexConnection *connection, const char *authorization_id, axlPointer user_data)
 Asynchronous notification to enable user space to accept or deny authentication for SASL EXTERNAL profile, and passes a user defined pointer.
typedef void(* VortexSaslAuthNotify )(VortexConnection *connection, VortexStatus status, char *status_message, axlPointer user_data)
 Async notifications for SASL auth process.
typedef axl_bool(* VortexSaslAuthPlain )(VortexConnection *connection, const char *auth_id, const char *authorization_id, const char *password)
 Asynchronous notification to enable user space code to validate SASL PLAIN request received.
typedef axl_bool(* VortexSaslAuthPlainFull )(VortexConnection *connection, const char *auth_id, const char *authorization_id, const char *password, axlPointer user_data)
 Asynchronous notification to enable user space code to validate SASL PLAIN request received.
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.
typedef axl_bool(* VortexTlsAcceptQuery )(VortexConnection *connection, char *serverName)
 Handler definition for those function used to configure if a given TLS request should be accepted or denied.
typedef void(* VortexTlsActivation )(VortexConnection *connection, VortexStatus status, char *status_message, axlPointer user_data)
 Async notifications for TLS activation.
typedef char *(* VortexTlsCertificateFileLocator )(VortexConnection *connection, char *serverName)
 Handler definition for those function allowing to locate the certificate file to be used while enabling TLS support.
typedef axlPointer(* VortexTlsCtxCreation )(VortexConnection *connection, axlPointer user_data)
 Handler definition used by the TLS profile, to allow the application level to provide the function that must be executed to create an (SSL_CTX *) object, used to perform the TLS activation.
typedef axl_bool(* VortexTlsPostCheck )(VortexConnection *connection, axlPointer user_data, axlPointer ssl, axlPointer ctx)
 Allows to configure a post-condition function to be executed to perform an addiontional checking.
typedef char *(* VortexTlsPrivateKeyFileLocator )(VortexConnection *connection, char *serverName)
 Handler definition for those function allowing to locate the private key file to be used while enabling TLS support.
typedef VortexTunnelSettings *(* VortexTunnelLocationResolver )(const char *tunnel_spec, int tunnel_spec_size, axlDoc *tunnel_doc, axlPointer user_data)
 Handler definition for the tunnel location resolution.
typedef void(* VortexXmlRpcBootNotify )(VortexChannel *booted_channel, VortexStatus status, char *message, axlPointer user_data)
 Async notification handler for the XML-RPC channel boot.
typedef XmlRpcMethodResponse *(* VortexXmlRpcServiceDispatch )(VortexChannel *channel, XmlRpcMethodCall *method_call, axlPointer user_data)
 Async handler to process all incoming service invocation through XML-RPC.
typedef axl_bool(* VortexXmlRpcValidateResource )(VortexConnection *connection, int channel_number, const char *serverName, const char *resource_path, axlPointer user_data)
 This async handler allows to control how is accepted XML-RPC initial boot channel based on a particular resource.
typedef void(* XmlRpcInvokeNotify )(VortexChannel *channel, XmlRpcMethodResponse *response, axlPointer user_data)
 Async method response notifier.