axis2_msg_ops Struct Reference
[message]

#include <axis2_msg.h>

List of all members.

Public Attributes

axis2_status_t(* free )(axis2_msg_t *msg, const axis2_env_t *env)
axis2_status_t(* add_param )(axis2_msg_t *msg, const axis2_env_t *env, axis2_param_t *param)
axis2_param_t *(* get_param )(const axis2_msg_t *msg, const axis2_env_t *env, const axis2_char_t *name)
axis2_array_list_t *(* get_all_params )(const axis2_msg_t *msg, const axis2_env_t *env)
axis2_bool_t(* is_param_locked )(axis2_msg_t *msg, const axis2_env_t *env, const axis2_char_t *param_name)
axis2_status_t(* set_parent )(axis2_msg_t *msg, const axis2_env_t *env, axis2_op_t *op)
axis2_op_t *(* get_parent )(const axis2_msg_t *msg, const axis2_env_t *env)
axis2_array_list_t *(* get_flow )(const axis2_msg_t *msg, const axis2_env_t *env)
axis2_status_t(* set_flow )(axis2_msg_t *msg, const axis2_env_t *env, axis2_array_list_t *flow)
const axis2_char_t *(* get_direction )(const axis2_msg_t *msg, const axis2_env_t *env)
axis2_status_t(* set_direction )(axis2_msg_t *msg, const axis2_env_t *env, const axis2_char_t *direction)
const axis2_qname_t *(* get_element_qname )(const axis2_msg_t *msg, const axis2_env_t *env)
axis2_status_t(* set_element_qname )(axis2_msg_t *msg, const axis2_env_t *env, const axis2_qname_t *element_qname)
const axis2_char_t *(* get_name )(const axis2_msg_t *msg, const axis2_env_t *env)
axis2_status_t(* set_name )(axis2_msg_t *msg, const axis2_env_t *env, const axis2_char_t *name)
xml_schema_element_t *(* get_schema_element )(const axis2_msg_t *msg, const axis2_env_t *env)


Detailed Description

message ops struct. Encapsulator struct for ops of axis2_msg.


Member Data Documentation

axis2_status_t( * axis2_msg_ops::add_param)(axis2_msg_t *msg, const axis2_env_t *env, axis2_param_t *param)

Adds a parameter.

Parameters:
msg pointer to message
env pointer to environment struct
param pointer to parameter, message assumes ownership of parameter
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_msg_ops::free)(axis2_msg_t *msg, const axis2_env_t *env)

Frees message.

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

axis2_array_list_t*( * axis2_msg_ops::get_all_params)(const axis2_msg_t *msg, const axis2_env_t *env)

Gets all parameters stored in message.

Parameters:
msg pointer to message
env pointer to environment struct
Returns:
pointer to list of parameters, returns a reference, not a cloned copy

const axis2_char_t*( * axis2_msg_ops::get_direction)(const axis2_msg_t *msg, const axis2_env_t *env)

Gets direction of message.

Parameters:
msg pointer to message
env pointer to environment struct
Returns:
direction string

const axis2_qname_t*( * axis2_msg_ops::get_element_qname)(const axis2_msg_t *msg, const axis2_env_t *env)

Gets QName representing message.

Parameters:
msg pointer to message
env pointer to environment struct
Returns:
pointer to QName, returns a reference, not a cloned copy

axis2_array_list_t*( * axis2_msg_ops::get_flow)(const axis2_msg_t *msg, const axis2_env_t *env)

Gets flow of execution associated with the message.

Parameters:
msg pointer to message
env pointer to environment struct
Returns:
pointer to array list containing the list of phases representing the flow

const axis2_char_t*( * axis2_msg_ops::get_name)(const axis2_msg_t *msg, const axis2_env_t *env)

Gets message name.

Parameters:
msg pointer to message
env pointer to environment struct
Returns:
message name string.

axis2_param_t*( * axis2_msg_ops::get_param)(const axis2_msg_t *msg, const axis2_env_t *env, const axis2_char_t *name)

Gets the named parameter.

Parameters:
msg pointer to message
env pointer to environment struct
name parameter name string
Returns:
pointer to parameter corresponding to the same name, returns a reference, not a cloned copy

axis2_op_t*( * axis2_msg_ops::get_parent)(const axis2_msg_t *msg, const axis2_env_t *env)

Gets parent. Parent of a message is of type operation.

Parameters:
msg pointer to message
env pointer to environment struct
Returns:
pointer to parent operation, returns a reference, not a cloned copy

xml_schema_element_t*( * axis2_msg_ops::get_schema_element)(const axis2_msg_t *msg, const axis2_env_t *env)

Gets XML schema element associated with the message.

Parameters:
msg pointer to message
env pointer to environment struct
Returns:
pointer to XML schema element, returns a reference, not a cloned copy

axis2_bool_t( * axis2_msg_ops::is_param_locked)(axis2_msg_t *msg, const axis2_env_t *env, const axis2_char_t *param_name)

Checks if the named parameter is locked.

Parameters:
msg pointer to message
env pointer to environment struct
param_name parameter name string
Returns:
AXIS2_TRUE if the parameter is locked, else AXIS2_FALSE

axis2_status_t( * axis2_msg_ops::set_direction)(axis2_msg_t *msg, const axis2_env_t *env, const axis2_char_t *direction)

Sets direction of message.

Parameters:
msg pointer to message
env pointer to environment struct
direction pointer to direction
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_msg_ops::set_element_qname)(axis2_msg_t *msg, const axis2_env_t *env, const axis2_qname_t *element_qname)

Sets QName representing message.

Parameters:
msg pointer to message
env pointer to environment struct
element_qname pointer to QName representing message, this function creates a clone of QName
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_msg_ops::set_flow)(axis2_msg_t *msg, const axis2_env_t *env, axis2_array_list_t *flow)

Sets flow of execution associated with the message.

Parameters:
msg pointer to message
env pointer to environment struct
flow pointer to array list of phases representing the flow, message assumes ownership of flow
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_msg_ops::set_name)(axis2_msg_t *msg, const axis2_env_t *env, const axis2_char_t *name)

Sets message name.

Parameters:
msg pointer to message
env pointer to environment struct
message name string
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_msg_ops::set_parent)(axis2_msg_t *msg, const axis2_env_t *env, axis2_op_t *op)

Sets parent. Parent of a message is of type operation.

Parameters:
msg pointer to message
env pointer to environment struct
op pointer to parent operation, message does not assume ownership of parent
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE


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