axis2_engine_ops Struct Reference
[engine]

#include <axis2_engine.h>

List of all members.

Public Attributes

axis2_status_t(* send )(axis2_engine_t *engine, const axis2_env_t *env, axis2_msg_ctx_t *msg_ctx)
axis2_status_t(* receive )(axis2_engine_t *engine, const axis2_env_t *env, axis2_msg_ctx_t *msg_ctx)
axis2_status_t(* send_fault )(axis2_engine_t *engine, const axis2_env_t *env, axis2_msg_ctx_t *msg_ctx)
axis2_status_t(* receive_fault )(axis2_engine_t *engine, const axis2_env_t *env, axis2_msg_ctx_t *msg_ctx)
axis2_msg_ctx_t *(* create_fault_msg_ctx )(axis2_engine_t *engine, const axis2_env_t *env, axis2_msg_ctx_t *processing_context)
axis2_status_t(* extract_fault_info_from_msg_ctx )(axis2_engine_t *engine, const axis2_env_t *env, axis2_msg_ctx_t *msg_ctx, struct axiom_soap_fault *fault)
axis2_status_t(* verify_ctx_built )(axis2_engine_t *engine, const axis2_env_t *env, axis2_msg_ctx_t *msg_ctx)
axis2_status_t(* invoke_phases )(axis2_engine_t *engine, const axis2_env_t *env, axis2_array_list_t *phases, axis2_msg_ctx_t *msg_ctx)
axis2_status_t(* resume_invocation_phases )(axis2_engine_t *engine, const axis2_env_t *env, axis2_array_list_t *phases, axis2_msg_ctx_t *msg_ctx)
const axis2_char_t *(* get_sender_fault_code )(const axis2_engine_t *engine, const axis2_env_t *env, const axis2_char_t *soap_namespace)
const axis2_char_t *(* get_receiver_fault_code )(const axis2_engine_t *engine, const axis2_env_t *env, const axis2_char_t *soap_namespace)
axis2_status_t(* free )(axis2_engine_t *engine, const axis2_env_t *env)
axis2_status_t(* resume_receive )(axis2_engine_t *engine, const axis2_env_t *env, axis2_msg_ctx_t *msg_ctx)
axis2_status_t(* resume_send )(axis2_engine_t *engine, const axis2_env_t *env, axis2_msg_ctx_t *msg_ctx)


Detailed Description

engine ops struct. Encapsulator struct for ops of axis2_engine.


Member Data Documentation

axis2_msg_ctx_t*( * axis2_engine_ops::create_fault_msg_ctx)(axis2_engine_t *engine, const axis2_env_t *env, axis2_msg_ctx_t *processing_context)

Creates a message context that represents the fault state based on current processing state.

Parameters:
engine pointer to engine
env pointer to environment struct
processing_context pointer to message context representing current processing context
Returns:
pointer to message context representing the fault state

axis2_status_t( * axis2_engine_ops::extract_fault_info_from_msg_ctx)(axis2_engine_t *engine, const axis2_env_t *env, axis2_msg_ctx_t *msg_ctx, struct axiom_soap_fault *fault)

Extracts fault information form message context.

Parameters:
engine pointer to engine
env pointer to environment struct
msg_ctx pointer to message context containing fault state
fault pointer to SOAP fault struct
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_engine_ops::free)(axis2_engine_t *engine, const axis2_env_t *env)

Frees engine struct.

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

const axis2_char_t*( * axis2_engine_ops::get_receiver_fault_code)(const axis2_engine_t *engine, const axis2_env_t *env, const axis2_char_t *soap_namespace)

Gets receiver's SOAP fault code.

Parameters:
engine pointer to engine
env pointer to environment struct
soap_namespace pointer to soap namespace

const axis2_char_t*( * axis2_engine_ops::get_sender_fault_code)(const axis2_engine_t *engine, const axis2_env_t *env, const axis2_char_t *soap_namespace)

Gets sender's SOAP fault code.

Parameters:
engine pointer to engine
env pointer to environment struct
soap_namespace pointer to SOAP namespace
Returns:
pointer to SOAP fault code string

axis2_status_t( * axis2_engine_ops::invoke_phases)(axis2_engine_t *engine, const axis2_env_t *env, axis2_array_list_t *phases, axis2_msg_ctx_t *msg_ctx)

Invokes the phases in the given array list of phases. The list of phases could be representing one of the flows. The two possible flows are in flow and out flow. Both of those flows can also have fault related representations, in fault flow and out fault flow. Invoking a phase triggers the invocation of handlers the phase contain.

Parameters:
engine pointer to engine
env pointer to environment struct
phases pointer to phases
msg_ctx pointer to message context containing current state
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_engine_ops::receive)(axis2_engine_t *engine, const axis2_env_t *env, axis2_msg_ctx_t *msg_ctx)

This methods represents the in flow of the Axis engine, both at the server side as well as the client side. In this function, the execution chain is created using the phases of the in flow. All handlers at each in flow phase, which are ordered in the deployment time are invoked in sequence here.

Parameters:
engine pointer to engine
env pointer to environment struct
msg_ctx pointer to message context representing current state that is used in receiving message
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_engine_ops::receive_fault)(axis2_engine_t *engine, const axis2_env_t *env, axis2_msg_ctx_t *msg_ctx)

This is invoked when a SOAP fault is received.

Parameters:
engine pointer to engine
env pointer to environment struct
msg_ctx pointer to message context representing that contains the details of receive state
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_engine_ops::resume_invocation_phases)(axis2_engine_t *engine, const axis2_env_t *env, axis2_array_list_t *phases, axis2_msg_ctx_t *msg_ctx)

Resumes phase invocation. While invoking the phases, one of the handlers in any phase could determine to pause the invocation. Often pausing happens to wait till some state is reached or some task is complete. Once paused, the invocation has to be resumed using this function, which will resume the invocation from the paused handler in the paused phase and will continue till it is paused again or it completes invoking all the remaining handlers in the remaining phases.

Parameters:
engine pointer to engine
env pointer to environment struct
phases pointer to phases
msg_ctx pointer to message context containing current paused state
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_engine_ops::resume_receive)(axis2_engine_t *engine, const axis2_env_t *env, axis2_msg_ctx_t *msg_ctx)

Resumes receive operation. It could be the case that receive was paused by one of the in flow handlers. In such a situation, this method could be used to resume the receive operation.

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

axis2_status_t( * axis2_engine_ops::resume_send)(axis2_engine_t *engine, const axis2_env_t *env, axis2_msg_ctx_t *msg_ctx)

Resumes send operation. It could be the case that send was paused by one of the out flow handlers. In such a situation, this method could be used to resume the send operation.

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

axis2_status_t( * axis2_engine_ops::send)(axis2_engine_t *engine, const axis2_env_t *env, axis2_msg_ctx_t *msg_ctx)

This methods represents the out flow of the Axis engine both at the server side as well as the client side. In this function, the execution chain is created using the phases of the out flow. All handlers at each out flow phase, which are ordered in the deployment time are invoked in sequence here.

Parameters:
engine pointer to engine
env pointer to environment struct
msg_ctx pointer to message context representing current state that is used when sending message
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_engine_ops::send_fault)(axis2_engine_t *engine, const axis2_env_t *env, axis2_msg_ctx_t *msg_ctx)

Sends a SOAP fault.

Parameters:
engine pointer to engine
env pointer to environment struct
msg_ctx pointer to message context that contains details of fault state
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_engine_ops::verify_ctx_built)(axis2_engine_t *engine, const axis2_env_t *env, axis2_msg_ctx_t *msg_ctx)

Verifies that the context hierarchy consisting of service group context, service context and operation context is built.

Parameters:
engine pointer to engine
env pointer to environment struct
msg_ctx pointer to message context containing the context related information
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE


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