environment
[utilities]


Classes

struct  axutil_env
 Axis2 Environment struct. More...

Defines

#define AXIS2_ENV_CHECK(env, error_return)

Typedefs

typedef axutil_env axutil_env_t
 Axis2 Environment struct.

Functions

AXIS2_EXTERN axutil_env_taxutil_env_create_all (const axis2_char_t *log_file, const axutil_log_levels_t log_level)
AXIS2_EXTERN axutil_env_taxutil_env_create (axutil_allocator_t *allocator)
AXIS2_EXTERN axutil_env_taxutil_env_create_with_error (axutil_allocator_t *allocator, axutil_error_t *error)
AXIS2_EXTERN axutil_env_taxutil_env_create_with_error_log (axutil_allocator_t *allocator, axutil_error_t *error, axutil_log_t *log)
AXIS2_EXTERN axutil_env_taxutil_env_create_with_error_log_thread_pool (axutil_allocator_t *allocator, axutil_error_t *error, axutil_log_t *log, axutil_thread_pool_t *pool)
AXIS2_EXTERN void axutil_env_free (axutil_env_t *env)
AXIS2_EXTERN void axutil_env_free_masked (axutil_env_t *env, char mask)
AXIS2_EXTERN axis2_status_t axutil_env_enable_log (axutil_env_t *env, axis2_bool_t enable)
AXIS2_EXTERN axis2_status_t axutil_env_check_status (const axutil_env_t *env)

Typedef Documentation

typedef struct axutil_env axutil_env_t
 

Axis2 Environment struct.

Environment acts as a container for error, log, memory allocator and other routines


Function Documentation

AXIS2_EXTERN axis2_status_t axutil_env_check_status const axutil_env_t env  ) 
 

Checks the status code of environment

AXIS2_EXTERN axutil_env_t* axutil_env_create axutil_allocator_t allocator  ) 
 

Creates an environment struct. Users of axis2 should not use this function to create an environment. He should use the other two create functions.

Parameters:
allocator pointer to an instance of allocator struct. Must be non-NULL
Returns:
pointer to the newly created environment struct

AXIS2_EXTERN axutil_env_t* axutil_env_create_all const axis2_char_t *  log_file,
const axutil_log_levels_t  log_level
 

Creates an environment struct with all of its default parts, that is an allocator, error, log and a thread pool.

Parameters:
log_file name of the log file
log_level log level to be used
Returns:
pointer to the newly created environment struct

AXIS2_EXTERN axutil_env_t* axutil_env_create_with_error axutil_allocator_t allocator,
axutil_error_t error
 

Creates an environment struct

Parameters:
allocator pointer to an instance of allocator struct. Must be non-NULL
error pointer to an instance of error struct. Must be non-NULL. it would be taken as a flag for no logging.
Returns:
pointer to the newly created environment struct

AXIS2_EXTERN axutil_env_t* axutil_env_create_with_error_log axutil_allocator_t allocator,
axutil_error_t error,
axutil_log_t log
 

Creates an environment struct

Parameters:
allocator pointer to an instance of allocator struct. Must be non-NULL
error pointer to an instance of error struct. Must be non-NULL.
log pointer to an instance of log struct. May be NULL. If NULL it would be taken as a flag for no logging.
Returns:
pointer to the newly created environment struct

AXIS2_EXTERN axutil_env_t* axutil_env_create_with_error_log_thread_pool axutil_allocator_t allocator,
axutil_error_t error,
axutil_log_t log,
axutil_thread_pool_t *  pool
 

Creates an environment struct

Parameters:
allocator pointer to an instance of allocator struct. Must be non-NULL
error pointer to an instance of error struct. Must be non-NULL.
log pointer to an instance of log struct. May be NULL. If NULL it would be taken as a flag for no logging.
pool pointer to an instance of thread_pool. May be NULL. If NULL
Returns:
pointer to the newly created environment struct

AXIS2_EXTERN axis2_status_t axutil_env_enable_log axutil_env_t env,
axis2_bool_t  enable
 

Enables logging

AXIS2_EXTERN void axutil_env_free axutil_env_t env  ) 
 

Creates an environment struct

Parameters:
allocator pointer to an instance of allocator struct.
error pointer to an instance of error struct. Optional, can be NULL. If NULL default error handler would be used.
log pointer to an instance of log struct. Optional, can be NULL. If NULL default log handler would be used.
string pointer to an instance of string struct. Optional, can be NULL. If NULL default string handler would be used.
Returns:
pointer to the newly created environment struct

AXIS2_EXTERN void axutil_env_free_masked axutil_env_t env,
char  mask
 

Frees the environment

Parameters:
env environment to be freed
mask bit pattern to according to which the components of the env struct are freed 0x1 - Frees the log 0x2 - Frees the error 0x4 - Frees the thread pool You can use combinations to free multiple components as well Eg : 0x3 frees both log and error
Returns:
status of the operation


Generated on Thu May 3 12:31:03 2007 for Axis2/C by  doxygen 1.4.6