flow
[description]


Files

file  axis2_flow.h

Classes

struct  axis2_flow_ops
struct  axis2_flow

Defines

#define AXIS2_FLOW_FREE(flow, env)   ((flow)->ops->free (flow, env))
#define AXIS2_FLOW_ADD_HANDLER(flow, env, handler)   ((flow)->ops->add_handler (flow, env, handler))
#define AXIS2_FLOW_GET_HANDLER(flow, env, index)   ((flow)->ops->get_handler (flow, env, index))
#define AXIS2_FLOW_GET_HANDLER_COUNT(flow, env)   ((flow)->ops->get_handler_count (flow, env))

Typedefs

typedef axis2_flow_ops axis2_flow_ops_t
typedef axis2_flow axis2_flow_t

Functions

AXIS2_EXTERN axis2_flow_taxis2_flow_create (const axis2_env_t *env)
AXIS2_EXTERN axis2_status_t axis2_flow_free_void_arg (void *flow, const axis2_env_t *env)

Detailed Description

flow is a collection of handlers. This struct encapsulates the concept of an execution flow in the engine.

Define Documentation

#define AXIS2_FLOW_ADD_HANDLER ( flow,
env,
handler   )     ((flow)->ops->add_handler (flow, env, handler))

Adds handler.

See also:
axis2_flow_ops::add_handler

#define AXIS2_FLOW_FREE ( flow,
env   )     ((flow)->ops->free (flow, env))

Frees flow.

See also:
axis2_flow_ops::free

#define AXIS2_FLOW_GET_HANDLER ( flow,
env,
index   )     ((flow)->ops->get_handler (flow, env, index))

Gets handler at given index.

See also:
axis2_flow_ops::get_handler

#define AXIS2_FLOW_GET_HANDLER_COUNT ( flow,
env   )     ((flow)->ops->get_handler_count (flow, env))

Gets handler count.

See also:
axis2_flow_ops::get_handler_count


Typedef Documentation

typedef struct axis2_flow_ops axis2_flow_ops_t

Type name for struct axis2_flow_ops

typedef struct axis2_flow axis2_flow_t

Type name for struct axis2_flow


Function Documentation

AXIS2_EXTERN axis2_flow_t* axis2_flow_create ( const axis2_env_t env  ) 

Creates flow struct.

Parameters:
env pointer to environment struct
Returns:
pointer to newly created flow

AXIS2_EXTERN axis2_status_t axis2_flow_free_void_arg ( void *  flow,
const axis2_env_t env 
)

Frees flow passed as void pointer. This method would cast the void pointer to appropriate type and then call free method.

Parameters:
flow pointer to flow
env pointer to environment struct
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE


Generated on Thu Oct 26 21:11:35 2006 for Axis2/C by  doxygen 1.4.7