Functions
Vortex context: functions to manage vortex context, an object that represent a vortex library state.

Functions

void vortex_ctx_close_conn_on_write_timeout (VortexCtx *ctx, axl_bool disable)
 Allows to disable/enable write timeout operations for all connections running on the provided context. More...
 
void vortex_ctx_free (VortexCtx *ctx)
 Releases the memory allocated by the provided VortexCtx. More...
 
void vortex_ctx_free2 (VortexCtx *ctx, const char *who)
 Releases the memory allocated by the provided VortexCtx. More...
 
axlPointer vortex_ctx_get_data (VortexCtx *ctx, const char *key)
 Allows to retreive data stored on the given context (vortex_ctx_set_data) using the provided index key. More...
 
void vortex_ctx_install_cleanup (VortexCtx *ctx, axlDestroyFunc cleanup)
 Allows to install a cleanup function which will be called just before the VortexCtx is finished (by a call to vortex_exit_ctx or a manual call to vortex_ctx_free). More...
 
VortexCtxvortex_ctx_new (void)
 Creates a new vortex execution context. More...
 
void vortex_ctx_ref (VortexCtx *ctx)
 Allows to increase reference count to the VortexCtx instance. More...
 
void vortex_ctx_ref2 (VortexCtx *ctx, const char *who)
 Allows to increase reference count to the VortexCtx instance. More...
 
int vortex_ctx_ref_count (VortexCtx *ctx)
 Allows to get current reference counting state from provided vortex context. More...
 
void vortex_ctx_remove_cleanup (VortexCtx *ctx, axlDestroyFunc cleanup)
 Allows to remove a cleanup function installed previously with vortex_ctx_install_cleanup. More...
 
void vortex_ctx_server_name_acquire (VortexCtx *ctx, axl_bool status)
 Allows to set a global configuration to enable/disable automatic serverName acquisition from connection host name used. More...
 
void vortex_ctx_set_channel_added_handler (VortexCtx *ctx, VortexConnectionOnChannelUpdate added_handler, axlPointer user_data)
 Allows to configure a global handler that is called each time a channel is added to any connection. More...
 
void vortex_ctx_set_channel_removed_handler (VortexCtx *ctx, VortexConnectionOnChannelUpdate removed_handler, axlPointer user_data)
 Allows to configure a global handler that is called each time a channel is removed from any connection. More...
 
void vortex_ctx_set_channel_start_handler (VortexCtx *ctx, VortexOnStartChannelExtended start_handler, axlPointer start_handler_data)
 Allows to configure a global start channel handler (for incoming start request) which is applicable for all profiles and override vortex profiles module configuration. More...
 
void vortex_ctx_set_close_notify_handler (VortexCtx *ctx, VortexOnNotifyCloseChannel close_notify, axlPointer user_data)
 Allows to configure a global close notify handler on the provided on the provided context. More...
 
void vortex_ctx_set_data (VortexCtx *ctx, const char *key, axlPointer value)
 Allows to store arbitrary data associated to the provided context, which can later retrieved using a particular key. More...
 
void vortex_ctx_set_data_full (VortexCtx *ctx, const char *key, axlPointer value, axlDestroyFunc key_destroy, axlDestroyFunc value_destroy)
 Allows to store arbitrary data associated to the provided context, which can later retrieved using a particular key. More...
 
void vortex_ctx_set_frame_received (VortexCtx *ctx, VortexOnFrameReceived received, axlPointer received_user_data)
 Allows to configure a global frame received handler where all frames are delivered, overriding first and second level handlers. More...
 
void vortex_ctx_set_idle_handler (VortexCtx *ctx, VortexIdleHandler idle_handler, long max_idle_period, axlPointer user_data, axlPointer user_data2)
 Allows to configure idle handler at context level. More...
 
void vortex_ctx_set_on_finish (VortexCtx *ctx, VortexOnFinishHandler finish_handler, axlPointer user_data)
 Allows to configure a finish handler which is called once the process (vortex reader) detects no more pending connections are available. More...
 
void vortex_ctx_unref (VortexCtx **ctx)
 Decrease reference count and nullify caller's pointer in the case the count reaches 0. More...
 
void vortex_ctx_unref2 (VortexCtx **ctx, const char *who)
 Decrease reference count and nullify caller's pointer in the case the count reaches 0. More...
 
void vortex_ctx_write_timeout (VortexCtx *ctx, int timeout)
 Allows to configure default write timeout to be used on the provided context. More...
 

Detailed Description