module description
[description]


Classes

struct  axis2_module_desc_ops
struct  axis2_module_desc

Defines

#define AXIS2_MODULE_DESC_FREE(module_desc, env)   ((module_desc)->ops->free(module_desc, env))
#define AXIS2_MODULE_DESC_GET_IN_FLOW(module_desc, env)   ((module_desc)->ops->get_in_flow (module_desc, env))
#define AXIS2_MODULE_DESC_SET_IN_FLOW(module_desc, env, in_flow)   ((module_desc)->ops->set_in_flow (module_desc, env, in_flow))
#define AXIS2_MODULE_DESC_GET_OUT_FLOW(module_desc, env)   ((module_desc)->ops->get_out_flow (module_desc, env))
#define AXIS2_MODULE_DESC_SET_OUT_FLOW(module_desc, env, out_flow)   ((module_desc)->ops->set_out_flow (module_desc, env, out_flow))
#define AXIS2_MODULE_DESC_GET_FAULT_IN_FLOW(module_desc, env)   ((module_desc)->ops->get_fault_in_flow (module_desc, env))
#define AXIS2_MODULE_DESC_SET_FAULT_IN_FLOW(module_desc, env, falut_in_flow)   ((module_desc)->ops->set_fault_in_flow(module_desc , env, falut_in_flow))
#define AXIS2_MODULE_DESC_GET_FAULT_OUT_FLOW(module_desc, env)   ((module_desc)->ops->get_fault_out_flow(module_desc , env))
#define AXIS2_MODULE_DESC_SET_FAULT_OUT_FLOW(module_desc, env, falut_out_flow)   ((module_desc)->ops->set_fault_out_flow(module_desc , env, falut_out_flow))
#define AXIS2_MODULE_DESC_GET_QNAME(module_desc, env)   ((module_desc)->ops->get_qname(module_desc, env))
#define AXIS2_MODULE_DESC_SET_QNAME(module_desc, env, qname)   ((module_desc)->ops->set_qname(module_desc, env, qname))
#define AXIS2_MODULE_DESC_ADD_OP(module_desc, env, op)   ((module_desc)->ops->add_op(module_desc, env, op))
#define AXIS2_MODULE_DESC_GET_ALL_OPS(module_desc, env)   ((module_desc)->ops->get_all_ops(module_desc, env))
#define AXIS2_MODULE_DESC_GET_PARENT(module_desc, env)   ((module_desc)->ops->get_parent(module_desc, env))
#define AXIS2_MODULE_DESC_SET_PARENT(module_desc, env, parent)   ((module_desc)->ops->set_parent(module_desc, env, parent))
#define AXIS2_MODULE_DESC_ADD_PARAM(module_desc, env, param)   ((module_desc)->ops->add_param(module_desc, env, param))
#define AXIS2_MODULE_DESC_GET_PARAM(module_desc, env, name)   ((module_desc)->ops->get_param(module_desc, env, name))
#define AXIS2_MODULE_DESC_GET_ALL_PARAMS(module_desc, env)   ((module_desc)->ops->get_all_params(module_desc, env))
#define AXIS2_MODULE_DESC_IS_PARAM_LOCKED(module_desc, env, param_name)   ((module_desc)->ops->is_param_locked(module_desc, env, param_name))
#define AXIS2_MODULE_DESC_GET_MODULE(module_desc, env)   ((module_desc)->ops->get_module(module_desc, env))
#define AXIS2_MODULE_DESC_SET_MODULE(module_desc, env, module)   ((module_desc)->ops->set_module(module_desc, env, module))

Typedefs

typedef axis2_module_desc_ops axis2_module_desc_ops_t
typedef axis2_module_desc axis2_module_desc_t

Functions

AXIS2_EXTERN axis2_module_desc_taxis2_module_desc_create (const axis2_env_t *env)
AXIS2_EXTERN axis2_module_desc_taxis2_module_desc_create_with_qname (const axis2_env_t *env, const axis2_qname_t *qname)
AXIS2_EXTERN axis2_status_t axis2_module_desc_free_void_arg (void *module_desc, const axis2_env_t *env)

Detailed Description

module holds information about a module. This information includes module parameters and handler information. Modules are available to all services if axis2.xml has a module reference entry. Alternatively, a module could be made available to selected services by including a module reference entry in services.xml.

Define Documentation

#define AXIS2_MODULE_DESC_ADD_OP ( module_desc,
env,
op   )     ((module_desc)->ops->add_op(module_desc, env, op))

Adds given operation to list of operations.

See also:
axis2_module_desc_ops::add_op

#define AXIS2_MODULE_DESC_ADD_PARAM ( module_desc,
env,
param   )     ((module_desc)->ops->add_param(module_desc, env, param))

Adds parameter.

See also:
axis2_module_desc_ops::add_param

#define AXIS2_MODULE_DESC_FREE ( module_desc,
env   )     ((module_desc)->ops->free(module_desc, env))

Frees module description.

See also:
axis2_module_desc_ops::free

#define AXIS2_MODULE_DESC_GET_ALL_OPS ( module_desc,
env   )     ((module_desc)->ops->get_all_ops(module_desc, env))

Gets list of all operations.

See also:
axis2_module_desc_ops::get_all_ops

#define AXIS2_MODULE_DESC_GET_ALL_PARAMS ( module_desc,
env   )     ((module_desc)->ops->get_all_params(module_desc, env))

Get all parameters.

See also:
axis2_module_desc_ops::get_all_params

#define AXIS2_MODULE_DESC_GET_FAULT_IN_FLOW ( module_desc,
env   )     ((module_desc)->ops->get_fault_in_flow (module_desc, env))

Gets fault in flow.

See also:
axis2_module_desc_ops::get_fault_in_flow

#define AXIS2_MODULE_DESC_GET_FAULT_OUT_FLOW ( module_desc,
env   )     ((module_desc)->ops->get_fault_out_flow(module_desc , env))

Gets fault out flow.

See also:
axis2_module_desc_ops::get_fault_out_flow

#define AXIS2_MODULE_DESC_GET_IN_FLOW ( module_desc,
env   )     ((module_desc)->ops->get_in_flow (module_desc, env))

Gets in flow.

See also:
axis2_module_desc_ops::get_in_flow

#define AXIS2_MODULE_DESC_GET_MODULE ( module_desc,
env   )     ((module_desc)->ops->get_module(module_desc, env))

Gets module associated with module description.

See also:
axis2_module_desc_ops::get_module

#define AXIS2_MODULE_DESC_GET_OUT_FLOW ( module_desc,
env   )     ((module_desc)->ops->get_out_flow (module_desc, env))

Gets out flow.

See also:
axis2_module_desc_ops::get_out_flow

#define AXIS2_MODULE_DESC_GET_PARAM ( module_desc,
env,
name   )     ((module_desc)->ops->get_param(module_desc, env, name))

Gets named parameter.

See also:
axis2_module_desc_ops::get_param

#define AXIS2_MODULE_DESC_GET_PARENT ( module_desc,
env   )     ((module_desc)->ops->get_parent(module_desc, env))

Gets parent.

See also:
axis2_module_desc_ops::get_parent

#define AXIS2_MODULE_DESC_GET_QNAME ( module_desc,
env   )     ((module_desc)->ops->get_qname(module_desc, env))

Gets QName.

See also:
axis2_module_desc_ops::get_qname

#define AXIS2_MODULE_DESC_IS_PARAM_LOCKED ( module_desc,
env,
param_name   )     ((module_desc)->ops->is_param_locked(module_desc, env, param_name))

Checks if named parameter is locked.

See also:
axis2_module_desc_ops::is_param_locked

#define AXIS2_MODULE_DESC_SET_FAULT_IN_FLOW ( module_desc,
env,
falut_in_flow   )     ((module_desc)->ops->set_fault_in_flow(module_desc , env, falut_in_flow))

Sets fault in flow.

See also:
axis2_module_desc_ops::set_fault_in_flow

#define AXIS2_MODULE_DESC_SET_FAULT_OUT_FLOW ( module_desc,
env,
falut_out_flow   )     ((module_desc)->ops->set_fault_out_flow(module_desc , env, falut_out_flow))

Sets fault out flow.

See also:
axis2_module_desc_ops::set_fault_out_flow

#define AXIS2_MODULE_DESC_SET_IN_FLOW ( module_desc,
env,
in_flow   )     ((module_desc)->ops->set_in_flow (module_desc, env, in_flow))

Sets in flow.

See also:
axis2_module_desc_ops::set_in_flow

#define AXIS2_MODULE_DESC_SET_MODULE ( module_desc,
env,
module   )     ((module_desc)->ops->set_module(module_desc, env, module))

Sets module associated with module description.

See also:
axis2_module_desc_ops::set_module

#define AXIS2_MODULE_DESC_SET_OUT_FLOW ( module_desc,
env,
out_flow   )     ((module_desc)->ops->set_out_flow (module_desc, env, out_flow))

Sets out flow.

See also:
axis2_module_desc_ops::set_out_flow

#define AXIS2_MODULE_DESC_SET_PARENT ( module_desc,
env,
parent   )     ((module_desc)->ops->set_parent(module_desc, env, parent))

Sets parent.

See also:
axis2_module_desc_ops::set_parent

#define AXIS2_MODULE_DESC_SET_QNAME ( module_desc,
env,
qname   )     ((module_desc)->ops->set_qname(module_desc, env, qname))

Sets QName.

See also:
axis2_module_desc_ops::set_qname


Typedef Documentation

typedef struct axis2_module_desc_ops axis2_module_desc_ops_t

Type name for struct axis2_module_desc_ops

typedef struct axis2_module_desc axis2_module_desc_t

Type name for struct axis2_module_desc


Function Documentation

AXIS2_EXTERN axis2_module_desc_t* axis2_module_desc_create ( const axis2_env_t env  ) 

Creates module description struct instance.

Parameters:
env pointer to environment struct
Returns:
pointer to newly created module description

AXIS2_EXTERN axis2_module_desc_t* axis2_module_desc_create_with_qname ( const axis2_env_t env,
const axis2_qname_t *  qname 
)

Creates module description struct instance with given QName.

Parameters:
env pointer to environment struct
qname pointer to QName
Returns:
pointer to newly created module description

AXIS2_EXTERN axis2_status_t axis2_module_desc_free_void_arg ( void *  module_desc,
const axis2_env_t env 
)

Frees module description passed as void pointer. This method will cast the void pointer parameter into appropriate type and then call module description free method on top of that pointer.

Parameters:
module_desc pointer to module description as a void pointer
env pointer to environment struct
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE


Generated on Tue Oct 3 22:36:00 2006 for Axis2/C by  doxygen 1.4.7