Macros | Enumerations | Functions
Vortex: Main Vortex Library Module (initialization and exit stuff)

Macros

#define VORTEX_CHECK_REF(ref, return_value)
 Allows to check the reference provided, and returning the return value provided. More...
 
#define VORTEX_CHECK_REF2(ref, return_value, ref2, free2_func)
 Allows to check the reference provided, returning the return value provided, also releasing a second reference with a custom free function. More...
 
#define VORTEX_MIN(a, b)   ((a) > (b) ? b : a)
 Returns the minimum from two values. More...
 

Enumerations

enum  VortexConfItem {
  VORTEX_SOFT_SOCK_LIMIT = 1, VORTEX_HARD_SOCK_LIMIT = 2, VORTEX_LISTENER_BACKLOG = 3, VORTEX_ENFORCE_PROFILES_SUPPORTED = 4,
  VORTEX_AUTOMATIC_MIME_HANDLING = 5, VORTEX_SKIP_THREAD_POOL_WAIT = 6
}
 Allowed items to use for vortex_conf_get. More...
 

Functions

void vortex_color_log_enable (VortexCtx *ctx, axl_bool status)
 Enable console color log. More...
 
axl_bool vortex_color_log_is_enabled (VortexCtx *ctx)
 Allows to check if the color log is currently enabled. More...
 
axl_bool vortex_conf_get (VortexCtx *ctx, VortexConfItem item, int *value)
 Allows to get a vortex configuration, providing a valid vortex item. More...
 
axl_bool vortex_conf_set (VortexCtx *ctx, VortexConfItem item, int value, const char *str_value)
 Allows to configure the provided item, with either the integer or the string value, according to the item configuration documentation. More...
 
void vortex_exit_ctx (VortexCtx *ctx, axl_bool free_ctx)
 Terminates the vortex library execution on the provided context. More...
 
axl_bool vortex_init_check (VortexCtx *ctx)
 Allows to check if the provided VortexCtx is initialized (vortex_init_ctx). More...
 
axl_bool vortex_init_ctx (VortexCtx *ctx)
 Context based vortex library init. More...
 
axl_bool vortex_is_exiting (VortexCtx *ctx)
 Allows to check if vortex engine started on the provided context is finishing (a call to vortex_exit_ctx was done). More...
 
void vortex_log2_enable (VortexCtx *ctx, axl_bool status)
 Enable console second level vortex log. More...
 
axl_bool vortex_log2_is_enabled (VortexCtx *ctx)
 Allows to get current status for second level log debug info to console. More...
 
void vortex_log_acquire_mutex (VortexCtx *ctx, axl_bool status)
 If activate the console debug, it may happen that some messages are mixed because several threads are producing them at the same time. More...
 
void vortex_log_enable (VortexCtx *ctx, axl_bool status)
 Enable console vortex log. More...
 
axl_bool vortex_log_filter_is_enabled (VortexCtx *ctx)
 Allows to check if current VORTEX_DEBUG_FILTER is enabled. More...
 
void vortex_log_filter_level (VortexCtx *ctx, const char *filter_string)
 Allows to configure which levels will be filtered from log output. More...
 
VortexLogHandler vortex_log_get_handler (VortexCtx *ctx)
 Allows to get current log handler configured. More...
 
axl_bool vortex_log_is_enabled (VortexCtx *ctx)
 Allows to get current status for log debug info to console. More...
 
axl_bool vortex_log_is_enabled_acquire_mutex (VortexCtx *ctx)
 Allows to check if the log mutex acquire is activated. More...
 
void vortex_log_set_handler (VortexCtx *ctx, VortexLogHandler handler)
 Allows to configure an application handler that will be called for each log produced by the vortex engine. More...
 
void vortex_log_set_handler_full (VortexCtx *ctx, VortexLogHandlerFull handler, axlPointer user_data)
 Allows to configure an application handler that will be called for each log produced by the vortex engine. More...
 
void vortex_log_set_prepare_log (VortexCtx *ctx, axl_bool prepare_string)
 Allows to instruct vortex to send string logs already formated into the log handler configured (vortex_log_set_handler). More...
 

Detailed Description