axis2_module_desc_ops Struct Reference
[module description]

#include <axis2_module_desc.h>

List of all members.

Public Attributes

axis2_status_t(* free )(axis2_module_desc_t *module_desc, const axis2_env_t *env)
axis2_flow_t *(* get_in_flow )(const axis2_module_desc_t *module_desc, const axis2_env_t *env)
axis2_status_t(* set_in_flow )(axis2_module_desc_t *module_desc, const axis2_env_t *env, axis2_flow_t *in_flow)
axis2_flow_t *(* get_out_flow )(const axis2_module_desc_t *module_desc, const axis2_env_t *env)
axis2_status_t(* set_out_flow )(axis2_module_desc_t *module_desc, const axis2_env_t *env, axis2_flow_t *out_flow)
axis2_flow_t *(* get_fault_in_flow )(const axis2_module_desc_t *module_desc, const axis2_env_t *env)
axis2_status_t(* set_fault_in_flow )(axis2_module_desc_t *module_desc, const axis2_env_t *env, axis2_flow_t *falut_in_flow)
axis2_flow_t *(* get_fault_out_flow )(const axis2_module_desc_t *module_desc, const axis2_env_t *env)
axis2_status_t(* set_fault_out_flow )(axis2_module_desc_t *module_desc, const axis2_env_t *env, axis2_flow_t *fault_out_flow)
const axis2_qname_t *(* get_qname )(const axis2_module_desc_t *module_desc, const axis2_env_t *env)
axis2_status_t(* set_qname )(axis2_module_desc_t *module_desc, const axis2_env_t *env, const axis2_qname_t *qname)
axis2_status_t(* add_op )(axis2_module_desc_t *module_desc, const axis2_env_t *env, struct axis2_op *op)
axis2_hash_t *(* get_all_ops )(const axis2_module_desc_t *module_desc, const axis2_env_t *env)
axis2_conf *(* get_parent )(const axis2_module_desc_t *module_desc, const axis2_env_t *env)
axis2_status_t(* set_parent )(axis2_module_desc_t *module_desc, const axis2_env_t *env, struct axis2_conf *parent)
axis2_status_t(* add_param )(axis2_module_desc_t *module_desc, const axis2_env_t *env, axis2_param_t *param)
axis2_param_t *(* get_param )(const axis2_module_desc_t *module_desc, const axis2_env_t *env, const axis2_char_t *name)
axis2_array_list_t *(* get_all_params )(const axis2_module_desc_t *module_desc, const axis2_env_t *env)
axis2_bool_t(* is_param_locked )(const axis2_module_desc_t *module_desc, const axis2_env_t *env, const axis2_char_t *param_name)
axis2_module *(* get_module )(const axis2_module_desc_t *module_desc, const axis2_env_t *env)
axis2_status_t(* set_module )(axis2_module_desc_t *module_desc, const axis2_env_t *env, struct axis2_module *module)


Detailed Description

module description ops struct. Encapsulator struct for ops of axis2_module_desc.


Member Data Documentation

axis2_status_t( * axis2_module_desc_ops::add_op)(axis2_module_desc_t *module_desc, const axis2_env_t *env, struct axis2_op *op)

Adds given operation to module.

Parameters:
module_desc pointer to module description
env pointer to environment struct
op pointer to operation, module assumes ownership of operation
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_module_desc_ops::add_param)(axis2_module_desc_t *module_desc, const axis2_env_t *env, axis2_param_t *param)

Add parameter

Parameters:
module_desc pointer to module description
env pointer to environment struct
param pointer to parameter struct
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_module_desc_ops::free)(axis2_module_desc_t *module_desc, const axis2_env_t *env)

Frees module description.

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

axis2_hash_t*( * axis2_module_desc_ops::get_all_ops)(const axis2_module_desc_t *module_desc, const axis2_env_t *env)

Gets all operations associated with module.

Parameters:
module_desc pointer to module description
env pointer to environment struct
Returns:
pointer to hash map containing the operations

axis2_array_list_t*( * axis2_module_desc_ops::get_all_params)(const axis2_module_desc_t *module_desc, const axis2_env_t *env)

Gets all parameters associated with module.

Parameters:
module_desc pointer to module description
env pointer to environment struct
pointer to array list containing all parameters

axis2_flow_t*( * axis2_module_desc_ops::get_fault_in_flow)(const axis2_module_desc_t *module_desc, const axis2_env_t *env)

Gets flow representing fault in flow.

Parameters:
module_desc pointer to module description
env pointer to environment struct
Returns:
pointer to flow that represents fault in flow, returns a reference not a cloned copy

axis2_flow_t*( * axis2_module_desc_ops::get_fault_out_flow)(const axis2_module_desc_t *module_desc, const axis2_env_t *env)

Gets flow representing fault out flow.

Parameters:
module_desc pointer to module description
env pointer to environment struct
Returns:
pointer to flow that represents fault out flow, returns a reference not a cloned copy

axis2_flow_t*( * axis2_module_desc_ops::get_in_flow)(const axis2_module_desc_t *module_desc, const axis2_env_t *env)

Gets flow representing in flow.

Parameters:
module_desc pointer to module description
env pointer to environment struct
Returns:
pointer to flow that represents in flow, returns a reference not a cloned copy

struct axis2_module*( * axis2_module_desc_ops::get_module)(const axis2_module_desc_t *module_desc, const axis2_env_t *env)

Gets module associated with module description.

Parameters:
module_desc pointer to module description
env pointer to environment struct
Returns:
pointer to module

axis2_flow_t*( * axis2_module_desc_ops::get_out_flow)(const axis2_module_desc_t *module_desc, const axis2_env_t *env)

Gets flow representing out flow.

Parameters:
module_desc pointer to module description
env pointer to environment struct
Returns:
pointer to flow that represents out flow, returns a reference not a cloned copy

axis2_param_t*( * axis2_module_desc_ops::get_param)(const axis2_module_desc_t *module_desc, const axis2_env_t *env, const axis2_char_t *name)

Gets parameter with given name.

Parameters:
module_desc pointer to module description
env pointer to environment struct
name parameter name string
Returns:
pointer to parameter corresponding to given name

struct axis2_conf*( * axis2_module_desc_ops::get_parent)(const axis2_module_desc_t *module_desc, const axis2_env_t *env)

Gets parent which is of type configuration.

Parameters:
module_desc pointer to module description
env pointer to environment struct
Returns:
pointer to configuration, returns a reference not a cloned copy

const axis2_qname_t*( * axis2_module_desc_ops::get_qname)(const axis2_module_desc_t *module_desc, const axis2_env_t *env)

Gets module QName.

Parameters:
module_desc pointer to module description
env pointer to environment struct
Returns:
pointer to QName

axis2_bool_t( * axis2_module_desc_ops::is_param_locked)(const axis2_module_desc_t *module_desc, const axis2_env_t *env, const axis2_char_t *param_name)

Checks if a given parameter is locked.

Parameters:
module_desc pointer to module description
env pointer to environment struct
param_name parameter name string
Returns:
AXIS2_TRUE if named parameter is locked, else AXIS2_FALSE

axis2_status_t( * axis2_module_desc_ops::set_fault_in_flow)(axis2_module_desc_t *module_desc, const axis2_env_t *env, axis2_flow_t *falut_in_flow)

Sets flow representing fault in flow.

Parameters:
module_desc pointer to module description
env pointer to environment struct
falut_in_flow pointer to flow representing fault in flow, module assumes ownership of flow
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_module_desc_ops::set_fault_out_flow)(axis2_module_desc_t *module_desc, const axis2_env_t *env, axis2_flow_t *fault_out_flow)

Sets flow representing fault out flow.

Parameters:
module_desc pointer to module description
env pointer to environment struct
fault_out_flow pointer to flow representing fault out flow, module assumes ownership of flow
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_module_desc_ops::set_in_flow)(axis2_module_desc_t *module_desc, const axis2_env_t *env, axis2_flow_t *in_flow)

Sets flow representing in flow.

Parameters:
module_desc pointer to module description
env pointer to environment struct
in_flow pointer to flow representing in flow, module assumes ownership of flow
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_module_desc_ops::set_module)(axis2_module_desc_t *module_desc, const axis2_env_t *env, struct axis2_module *module)

Parameters:
module_desc pointer to module description
env pointer to environment struct
module pointer to module, module description assumes ownership of module
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_module_desc_ops::set_out_flow)(axis2_module_desc_t *module_desc, const axis2_env_t *env, axis2_flow_t *out_flow)

Sets flow representing out flow.

Parameters:
module_desc pointer to module description
env pointer to environment struct
out_flow pointer to flow representing out flow, module assumes ownership of flow
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_module_desc_ops::set_parent)(axis2_module_desc_t *module_desc, const axis2_env_t *env, struct axis2_conf *parent)

Sets parent which is of type configuration.

Parameters:
module_desc pointer to module description
env pointer to environment struct
parent pointer to parent configuration, module does not assume the ownership of configuration
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_module_desc_ops::set_qname)(axis2_module_desc_t *module_desc, const axis2_env_t *env, const axis2_qname_t *qname)

Sets module QName.

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


The documentation for this struct was generated from the following file:
Generated on Tue Oct 3 18:21:18 2006 for Axis2/C by  doxygen 1.4.7