handler
[handler]


Files

file  axis2_handler.h

Modules

 handler

Classes

struct  axis2_handler_ops
struct  axis2_handler

Defines

#define AXIS2_HANDLER_FREE(handler, env)   ((handler)->ops->free(handler, env))
#define AXIS2_HANDLER_INIT(handler, env, handler_desc)   ((handler)->ops->init(handler, env, handler_desc))
#define AXIS2_HANDLER_INVOKE(handler, env, msg_ctx)   ((handler)->ops->invoke(handler, env, msg_ctx))
#define AXIS2_HANDLER_GET_QNAME(handler, env)   ((handler)->ops->get_qname(handler, env))
#define AXIS2_HANDLER_GET_PARAM(handler, env, name)   ((handler)->ops->get_param(handler, env, name))
#define AXIS2_HANDLER_GET_HANDLER_DESC(handler, env)   ((handler)->ops->get_handler_desc(handler, env))

Typedefs

typedef axis2_handler axis2_handler_t
typedef axis2_handler_ops axis2_handler_ops_t
typedef axis2_handler_t *(*) AXIS2_HANDLER_CREATE_FUNC (const axis2_env_t *env, const axis2_qname_t *qname)

Functions

AXIS2_EXTERN axis2_handler_taxis2_handler_create (const axis2_env_t *env)
AXIS2_EXTERN axis2_handler_taxis2_ctx_handler_create (const axis2_env_t *env, const axis2_qname_t *qname)

Detailed Description

handler is the smallest unit of execution in the Axis2 engine's execution flow. The engine could have two flows, the in-flow and out-flow. A flow is a collection of phases and a phase in turn is a collection of handlers. handlers are configured in relation to modules. A module is a point of extension in the Axis2 engine and a module would have one or more handlers defined in its configuration. The module configuration defines the phases each handler is attached to. A handler is invoked when the phase within which it lives is invoked. handler is stateless and it is using the message context that the state information is captures across invocations.

Define Documentation

#define AXIS2_HANDLER_FREE ( handler,
env   )     ((handler)->ops->free(handler, env))

Frees handler.

See also:
axis2_handler_ops::free

#define AXIS2_HANDLER_GET_HANDLER_DESC ( handler,
env   )     ((handler)->ops->get_handler_desc(handler, env))

Gets handler description related to the handler.

See also:
axis2_handler_ops::get_handler_desc

#define AXIS2_HANDLER_GET_PARAM ( handler,
env,
name   )     ((handler)->ops->get_param(handler, env, name))

Gets the named parameter.

See also:
axis2_handler_ops::get_param

#define AXIS2_HANDLER_GET_QNAME ( handler,
env   )     ((handler)->ops->get_qname(handler, env))

Gets handler QName.

See also:
axis2_handler_ops::get_qname

#define AXIS2_HANDLER_INIT ( handler,
env,
handler_desc   )     ((handler)->ops->init(handler, env, handler_desc))

Initializes handler.

See also:
axis2_handler_ops::init

#define AXIS2_HANDLER_INVOKE ( handler,
env,
msg_ctx   )     ((handler)->ops->invoke(handler, env, msg_ctx))

Invokes the handler.

See also:
axis2_handler_ops::invoke


Typedef Documentation

typedef axis2_handler_t*( * ) AXIS2_HANDLER_CREATE_FUNC(const axis2_env_t *env, const axis2_qname_t *qname)

Function pointer defining the creates syntax for a handler struct instance.

Parameters:
env pointer to environment struct
pointer to qname
Returns:
pointer to newly created handler struct

typedef struct axis2_handler_ops axis2_handler_ops_t

Type name for struct axis2_handler_ops

typedef struct axis2_handler axis2_handler_t

Type name for struct axis2_handler


Function Documentation

AXIS2_EXTERN axis2_handler_t* axis2_ctx_handler_create ( const axis2_env_t env,
const axis2_qname_t *  qname 
)

Creates a handler with invoke method implemented to fill in the service and operation context information.

Parameters:
env pointer to environment struct
qname pointer to qname, this is cloned within create method
Returns:
pointer to newly created handler struct

AXIS2_EXTERN axis2_handler_t* axis2_handler_create ( const axis2_env_t env  ) 

Creates handler struct instance.

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


Generated on Tue Oct 3 20:48:10 2006 for Axis2/C by  doxygen 1.4.7