axis2_phase_ops Struct Reference
[phases]

#include <axis2_phase.h>

List of all members.

Public Attributes

axis2_status_t(* add_handler_at )(axis2_phase_t *phase, const axis2_env_t *env, const int index, axis2_handler_t *handler)
axis2_status_t(* add_handler )(axis2_phase_t *phase, const axis2_env_t *env, axis2_handler_t *handler)
axis2_status_t(* invoke )(axis2_phase_t *phase, const axis2_env_t *env, struct axis2_msg_ctx *msg_ctx)
const axis2_char_t *(* get_name )(const axis2_phase_t *phase, const axis2_env_t *env)
int(* get_handler_count )(const axis2_phase_t *phase, const axis2_env_t *env)
axis2_status_t(* set_first_handler )(axis2_phase_t *phase, const axis2_env_t *env, axis2_handler_t *handler)
axis2_status_t(* set_last_handler )(axis2_phase_t *phase, const axis2_env_t *env, axis2_handler_t *handler)
axis2_status_t(* add_handler_desc )(axis2_phase_t *phase, const axis2_env_t *env, axis2_handler_desc_t *handler_desc)
axis2_status_t(* insert_before )(axis2_phase_t *phase, const axis2_env_t *env, axis2_handler_t *handler)
axis2_status_t(* insert_after )(axis2_phase_t *phase, const axis2_env_t *env, axis2_handler_t *handler)
axis2_status_t(* insert_before_and_after )(axis2_phase_t *phase, const axis2_env_t *env, axis2_handler_t *handler)
axis2_status_t(* insert_handler_desc )(axis2_phase_t *phase, const axis2_env_t *env, axis2_handler_desc_t *handler_desc)
axis2_array_list_t *(* get_all_handlers )(const axis2_phase_t *phase, const axis2_env_t *env)
axis2_status_t(* invoke_start_from_handler )(axis2_phase_t *phase, const axis2_env_t *env, const int paused_handler_index, struct axis2_msg_ctx *msg_ctx)
axis2_status_t(* free )(axis2_phase_t *phase, const axis2_env_t *env)


Detailed Description

phase ops struct. Encapsulator struct for operations of axis2_phase.


Member Data Documentation

axis2_status_t( * axis2_phase_ops::add_handler)(axis2_phase_t *phase, const axis2_env_t *env, axis2_handler_t *handler)

Adds the given handler to the end of the handler list.

Parameters:
phase pointer to phase
env pointer to environment struct
handler pointer to handler, phase does not assume the ownership of the handler
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_phase_ops::add_handler_at)(axis2_phase_t *phase, const axis2_env_t *env, const int index, axis2_handler_t *handler)

Adds given handler to the specified position in the handler array list.

Parameters:
phase pointer to phase struct
env pointer to environment struct
index index
handler pointer to handler, phase does not assume the ownership of the handler
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_phase_ops::add_handler_desc)(axis2_phase_t *phase, const axis2_env_t *env, axis2_handler_desc_t *handler_desc)

Adds handler within the handler description to the list of handlers in the phase.

Parameters:
phase pointer to phase
env pointer to environment struct
handler_desc pointer to handler description, phase does not assume the ownership of neither the handler description not the handler within the handler description
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_phase_ops::free)(axis2_phase_t *phase, const axis2_env_t *env)

Frees phase struct.

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

axis2_array_list_t*( * axis2_phase_ops::get_all_handlers)(const axis2_phase_t *phase, const axis2_env_t *env)

Gets all the handlers in the phase.

Parameters:
phase pointer to phase
env pointer to environment struct
Returns:
pointer to array list containing the list of handlers

int( * axis2_phase_ops::get_handler_count)(const axis2_phase_t *phase, const axis2_env_t *env)

Gets handler count in the handler list.

Parameters:
phase pointer to phase
env pointer to environment struct
Returns:
the number of handlers in the handler list

const axis2_char_t*( * axis2_phase_ops::get_name)(const axis2_phase_t *phase, const axis2_env_t *env)

Gets phase name.

Parameters:
phase pointer to phase
env pointer to environment struct
Returns:
returns name of phase

axis2_status_t( * axis2_phase_ops::insert_after)(axis2_phase_t *phase, const axis2_env_t *env, axis2_handler_t *handler)

Inserts the handler into handler list of the phase based on the phase rules associated with the handler. This function takes into account the after rules of the handler. After rules specify the location of a current handler in the handler list, after which the given handler is to be placed.

Parameters:
phase pointer to phase
env pointer to environment struct
handler pointer to handler, phase does not assume the ownership of the handler
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_phase_ops::insert_before)(axis2_phase_t *phase, const axis2_env_t *env, axis2_handler_t *handler)

Inserts the handler into handler list of the phase based on the phase rules associated with the handler. This function takes into account the before rules of the handler. Before rules specify the location of a current handler in the handler list, before which the given handler is to be placed.

Parameters:
phase pointer to phase
env pointer to environment struct
handler pointer to handler, phase does not assume the ownership of the handler
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_phase_ops::insert_before_and_after)(axis2_phase_t *phase, const axis2_env_t *env, axis2_handler_t *handler)

Inserts the handler into handler list of the phase based on both before and after phase rules associated with the handler. This method assume that both the before and after cannot be the same handler . That condition is not checked by this function. It should be checked before calling this function

Parameters:
phase pointer to phase
env pointer to environment struct
handler pointer to handler, phase does not assume the ownership of the handler
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_phase_ops::insert_handler_desc)(axis2_phase_t *phase, const axis2_env_t *env, axis2_handler_desc_t *handler_desc)

Inserts the handler to the correct location in the handler list of the phase. Location is evaluated based on the phase rules.

Parameters:
phase pointer to phase
env pointer to environment struct
handler_desc pointer to handler description, phase does not assume the ownership of neither the handler description not the handler within the handler description
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_phase_ops::invoke)(axis2_phase_t *phase, const axis2_env_t *env, struct axis2_msg_ctx *msg_ctx)

Invokes the phase. This function will in turn call invoke method of each handler in the handler list, in sequence, starting from the beginning of the list to the end of the list.

Parameters:
phase pointer to phase
env pointer to environment struct
msg_ctx pointer to message context
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_phase_ops::invoke_start_from_handler)(axis2_phase_t *phase, const axis2_env_t *env, const int paused_handler_index, struct axis2_msg_ctx *msg_ctx)

Invokes handlers starting from the given handler index.

Parameters:
phase pointer to phase
env pointer to environment struct
paused_handler_index index of the handler to start the invocation from
msg_ctx pointer to message context
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_phase_ops::set_first_handler)(axis2_phase_t *phase, const axis2_env_t *env, axis2_handler_t *handler)

Sets the first handler in the handler list.

Parameters:
phase pointer to phase
env pointer to environment struct
handler pointer to handler, phase does not assume the ownership of the handler
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_phase_ops::set_last_handler)(axis2_phase_t *phase, const axis2_env_t *env, axis2_handler_t *handler)

Sets the last handler in the handler list.

Parameters:
phase pointer to phase
env pointer to environment struct
handler pointer to handler, phase does not assume the ownership of the handler
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE


The documentation for this struct was generated from the following file:
Generated on Thu Oct 26 21:11:47 2006 for Axis2/C by  doxygen 1.4.7