axis2_op_ctx_ops Struct Reference
[operation context]

#include <axis2_op_ctx.h>

List of all members.

Public Attributes

axis2_ctx_t *(* get_base )(const axis2_op_ctx_t *op_ctx, const axis2_env_t *env)
axis2_status_t(* free )(struct axis2_op_ctx *op_ctx, const axis2_env_t *env)
axis2_status_t(* init )(struct axis2_op_ctx *op_ctx, const axis2_env_t *env, struct axis2_conf *conf)
axis2_op *(* get_op )(const axis2_op_ctx_t *op_ctx, const axis2_env_t *env)
axis2_svc_ctx *(* get_parent )(const axis2_op_ctx_t *op_ctx, const axis2_env_t *env)
axis2_status_t(* add_msg_ctx )(struct axis2_op_ctx *op_ctx, const axis2_env_t *env, axis2_msg_ctx_t *msg_ctx)
axis2_msg_ctx_t *(* get_msg_ctx )(const axis2_op_ctx_t *op_ctx, const axis2_env_t *env, const axis2_char_t *message_id)
axis2_bool_t(* get_is_complete )(const axis2_op_ctx_t *op_ctx, const axis2_env_t *env)
axis2_status_t(* set_complete )(struct axis2_op_ctx *op_ctx, const axis2_env_t *env, axis2_bool_t is_complete)
axis2_status_t(* cleanup )(struct axis2_op_ctx *op_ctx, const axis2_env_t *env)
axis2_status_t(* set_parent )(struct axis2_op_ctx *op_ctx, const axis2_env_t *env, struct axis2_svc_ctx *svc_ctx)
axis2_hash_t *(* get_msg_ctx_map )(const axis2_op_ctx_t *op_ctx, const axis2_env_t *env)


Detailed Description

operation context ops struct. Encapsulator struct for ops of axis2_op_ctx.


Member Data Documentation

axis2_status_t( * axis2_op_ctx_ops::add_msg_ctx)(struct axis2_op_ctx *op_ctx, const axis2_env_t *env, axis2_msg_ctx_t *msg_ctx)
 

Adds a message context.

Parameters:
op_ctx pointer to operation context
env pointer to environment struct
msg_ctx pointer to message context struct, message context does not assume the ownership of the struct
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_op_ctx_ops::cleanup)(struct axis2_op_ctx *op_ctx, const axis2_env_t *env)
 

Cleans up the operation context. Clean up includes removing all message context references recorded in operation context.

Parameters:
op_ctx pointer to operation context
env pointer to environment struct
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_op_ctx_ops::free)(struct axis2_op_ctx *op_ctx, const axis2_env_t *env)
 

Frees operation context.

Parameters:
op_ctx pointer to operation context
env pointer to environment struct
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_ctx_t*( * axis2_op_ctx_ops::get_base)(const axis2_op_ctx_t *op_ctx, const axis2_env_t *env)
 

Gets base which is of context type.

Parameters:
op_ctx pointer to operation context
env pointer to environment struct
Returns:
pointer to base context

axis2_bool_t( * axis2_op_ctx_ops::get_is_complete)(const axis2_op_ctx_t *op_ctx, const axis2_env_t *env)
 

Gets the bool value indicating if the MEP is complete. MEP is considered complete when all the messages that are associated with the MEP has arrived.

Parameters:
op_ctx pointer to operation context
env pointer to environment struct
Returns:
AXIS2_TRUE if MEP invocation is complete, else AXIS2_FALSE

axis2_msg_ctx_t*( * axis2_op_ctx_ops::get_msg_ctx)(const axis2_op_ctx_t *op_ctx, const axis2_env_t *env, const axis2_char_t *message_id)
 

Gets message context with the given message ID.

Parameters:
op_ctx pointer to operation context
env pointer to environment struct
message_id message ID string
Returns:
pointer to message context with given ID

axis2_hash_t*( * axis2_op_ctx_ops::get_msg_ctx_map)(const axis2_op_ctx_t *op_ctx, const axis2_env_t *env)
 

Gets the message context map.

Parameters:
op_ctx pointer to operation context
env pointer to environment struct
Returns:
pointer to hash table containing message contexts

struct axis2_op*( * axis2_op_ctx_ops::get_op)(const axis2_op_ctx_t *op_ctx, const axis2_env_t *env)
 

Gets operation the operation context is related to.

Parameters:
op_ctx pointer to operation context
env pointer to environment struct
Returns:
pointer to operation

struct axis2_svc_ctx*( * axis2_op_ctx_ops::get_parent)(const axis2_op_ctx_t *op_ctx, const axis2_env_t *env)
 

Gets parent which is of service context type.

Parameters:
op_ctx pointer to operation context
env pointer to environment struct
Returns:
pointer to service context within which this operation context lives

axis2_status_t( * axis2_op_ctx_ops::init)(struct axis2_op_ctx *op_ctx, const axis2_env_t *env, struct axis2_conf *conf)
 

Initializes operation context. This method traverses through all the message contexts stored within it and initialize them all.

Parameters:
op_ctx pointer to operation context
env pointer to environment struct
conf pointer to conf configuration
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_op_ctx_ops::set_complete)(struct axis2_op_ctx *op_ctx, const axis2_env_t *env, axis2_bool_t is_complete)
 

Sets the bool value indicating if the MEP is complete. MEP is considered complete when all the messages that are associated with the MEP has arrived.

Parameters:
op_ctx pointer to operating context
env pointer to environment struct
is_complete AXIS2_TRUE if MEP invocation is complete, else AXIS2_FALSE
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_op_ctx_ops::set_parent)(struct axis2_op_ctx *op_ctx, const axis2_env_t *env, struct axis2_svc_ctx *svc_ctx)
 

Sets parent service context.

Parameters:
op_ctx pointer to operation context
env pointer to environment struct
svc_ctx pointer to service context, message context does not assume the ownership of the struct
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE


The documentation for this struct was generated from the following file:
Generated on Thu Aug 31 17:32:40 2006 for Axis2/C by  doxygen 1.4.6