axis2_msg_info_headers_ops Struct Reference
[message information headers]

#include <axis2_msg_info_headers.h>

List of all members.

Public Attributes

axis2_endpoint_ref_t *(* get_to )(const axis2_msg_info_headers_t *msg_info_headers, const axis2_env_t *env)
axis2_status_t(* set_to )(struct axis2_msg_info_headers *msg_info_headers, const axis2_env_t *env, axis2_endpoint_ref_t *to)
axis2_endpoint_ref_t *(* get_from )(const axis2_msg_info_headers_t *msg_info_headers, const axis2_env_t *env)
axis2_status_t(* set_from )(struct axis2_msg_info_headers *msg_info_headers, const axis2_env_t *env, axis2_endpoint_ref_t *from)
axis2_endpoint_ref_t *(* get_reply_to )(const axis2_msg_info_headers_t *msg_info_headers, const axis2_env_t *env)
axis2_status_t(* set_reply_to )(struct axis2_msg_info_headers *msg_info_headers, const axis2_env_t *env, axis2_endpoint_ref_t *reply_to)
axis2_status_t(* set_reply_to_none )(struct axis2_msg_info_headers *msg_info_headers, const axis2_env_t *env, const axis2_bool_t none)
axis2_bool_t(* get_reply_to_none )(const axis2_msg_info_headers_t *msg_info_headers, const axis2_env_t *env)
axis2_status_t(* set_reply_to_anonymous )(struct axis2_msg_info_headers *msg_info_headers, const axis2_env_t *env, const axis2_bool_t anonymous)
axis2_bool_t(* get_reply_to_anonymous )(const axis2_msg_info_headers_t *msg_info_headers, const axis2_env_t *env)
axis2_endpoint_ref_t *(* get_fault_to )(const axis2_msg_info_headers_t *msg_info_headers, const axis2_env_t *env)
axis2_status_t(* set_fault_to )(struct axis2_msg_info_headers *msg_info_headers, const axis2_env_t *env, axis2_endpoint_ref_t *fault_to)
axis2_status_t(* set_fault_to_none )(struct axis2_msg_info_headers *msg_info_headers, const axis2_env_t *env, const axis2_bool_t none)
axis2_bool_t(* get_fault_to_none )(const axis2_msg_info_headers_t *msg_info_headers, const axis2_env_t *env)
axis2_status_t(* set_fault_to_anonymous )(struct axis2_msg_info_headers *msg_info_headers, const axis2_env_t *env, const axis2_bool_t anonymous)
axis2_bool_t(* get_fault_to_anonymous )(const axis2_msg_info_headers_t *msg_info_headers, const axis2_env_t *env)
const axis2_char_t *(* get_action )(const axis2_msg_info_headers_t *msg_info_headers, const axis2_env_t *env)
axis2_status_t(* set_action )(struct axis2_msg_info_headers *msg_info_headers, const axis2_env_t *env, const axis2_char_t *action)
const axis2_char_t *(* get_message_id )(const axis2_msg_info_headers_t *msg_info_headers, const axis2_env_t *env)
axis2_status_t(* set_message_id )(struct axis2_msg_info_headers *msg_info_headers, const axis2_env_t *env, const axis2_char_t *message_id)
axis2_relates_to_t *(* get_relates_to )(const axis2_msg_info_headers_t *msg_info_headers, const axis2_env_t *env)
axis2_status_t(* set_relates_to )(struct axis2_msg_info_headers *msg_info_headers, const axis2_env_t *env, axis2_relates_to_t *relates_to)
axis2_array_list_t *(* get_all_ref_params )(const axis2_msg_info_headers_t *msg_info_headers, const axis2_env_t *env)
axis2_status_t(* add_ref_param )(struct axis2_msg_info_headers *msg_info_headers, const axis2_env_t *env, axiom_node_t *ref_param)
axis2_status_t(* free )(struct axis2_msg_info_headers *msg_info_headers, const axis2_env_t *env)


Detailed Description

message information headers ops struct.


Member Data Documentation

axis2_endpoint_ref_t*( * axis2_msg_info_headers_ops::get_to)(const axis2_msg_info_headers_t *msg_info_headers, const axis2_env_t *env)

Gets to endpoint. to endpoint represents the address of the intended receiver of this message.

Parameters:
msg_info_headers pointer to message information headers struct
env pointer to environment struct
Returns:
pointer to endpoint reference representing to address, returns a reference, not a cloned copy

axis2_status_t( * axis2_msg_info_headers_ops::set_to)(struct axis2_msg_info_headers *msg_info_headers, const axis2_env_t *env, axis2_endpoint_ref_t *to)

Sets to endpoint. to endpoint represents the address of the intended receiver of this message.

Parameters:
msg_info_headers pointer to message information headers struct
env pointer to environment struct
to pointer to endpoint reference representing to address, message information headers assumes ownership of the endpoint
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_endpoint_ref_t*( * axis2_msg_info_headers_ops::get_from)(const axis2_msg_info_headers_t *msg_info_headers, const axis2_env_t *env)

Gets from endpoint. from endpoint represents the address of the endpoint where the message originated from.

Parameters:
msg_info_headers pointer to message information headers struct
env pointer to environment struct
Returns:
pointer to endpoint reference representing from address, returns a reference, not a cloned copy

axis2_status_t( * axis2_msg_info_headers_ops::set_from)(struct axis2_msg_info_headers *msg_info_headers, const axis2_env_t *env, axis2_endpoint_ref_t *from)

Sets from endpoint. from endpoint represents the address of the endpoint where the message originated from.

Parameters:
msg_info_headers pointer to message information headers struct
env pointer to environment struct
from pointer to endpoint reference representing from address, message information headers assumes ownership of the endpoint
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_endpoint_ref_t*( * axis2_msg_info_headers_ops::get_reply_to)(const axis2_msg_info_headers_t *msg_info_headers, const axis2_env_t *env)

Gets reply to endpoint. reply to endpoint identifies the intended receiver for replies to a message.

Parameters:
msg_info_headers pointer to message information headers struct
env pointer to environment struct
Returns:
pointer to endpoint reference representing reply to address, returns a reference, not a cloned copy

axis2_status_t( * axis2_msg_info_headers_ops::set_reply_to)(struct axis2_msg_info_headers *msg_info_headers, const axis2_env_t *env, axis2_endpoint_ref_t *reply_to)

Sets reply to endpoint. reply to endpoint identifies the intended receiver for replies to a message.

Parameters:
msg_info_headers pointer to message information headers struct
env pointer to environment struct
reply_to pointer to endpoint reference representing reply to address, message information headers assumes ownership of the endpoint
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_msg_info_headers_ops::set_reply_to_none)(struct axis2_msg_info_headers *msg_info_headers, const axis2_env_t *env, const axis2_bool_t none)

Sets the bool value indicating whether the reply to endpoint should be none. reply to endpoint identifies the intended receiver for replies to a message. The URI "http://www.w3.org/2005/08/addressing/none" in the reply to address indicates that no reply should be sent.

Parameters:
msg_info_headers pointer to message information headers struct
env pointer to environment struct
none AXIS2_TRUE if http://www.w3.org/2005/08/addressing/none is to be used as reply to URI, else AXIS2_FALSE
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_bool_t( * axis2_msg_info_headers_ops::get_reply_to_none)(const axis2_msg_info_headers_t *msg_info_headers, const axis2_env_t *env)

Gets the bool value indicating whether the reply to endpoint should be none. reply to endpoint identifies the intended receiver for replies related to a message. The URI "http://www.w3.org/2005/08/addressing/none" in the reply to address indicates that no reply should be sent.

Parameters:
msg_info_headers pointer to message information headers struct
env pointer to environment struct
Returns:
AXIS2_TRUE if http://www.w3.org/2005/08/addressing/none is to be used as reply to URI, else AXIS2_FALSE

axis2_status_t( * axis2_msg_info_headers_ops::set_reply_to_anonymous)(struct axis2_msg_info_headers *msg_info_headers, const axis2_env_t *env, const axis2_bool_t anonymous)

Sets the bool value indicating whether the reply to endpoint should be anonymous. reply to endpoint identifies the intended receiver for replies related to a message. The URI "http://www.w3.org/2005/08/addressing/anonymous" in the reply to address indicates that reply should be sent to from address.

Parameters:
msg_info_headers pointer to message information headers struct
env pointer to environment struct
anonymous AXIS2_TRUE if http://www.w3.org/2005/08/addressing/anonymous is to be used as reply to URI, else AXIS2_FALSE
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_bool_t( * axis2_msg_info_headers_ops::get_reply_to_anonymous)(const axis2_msg_info_headers_t *msg_info_headers, const axis2_env_t *env)

Gets the bool value indicating whether the reply to endpoint should be anonymous. reply to endpoint identifies the intended receiver for replies related to a message. The URI "http://www.w3.org/2005/08/addressing/anonymous" in the reply to address indicates that reply should be sent to from address.

Parameters:
msg_info_headers pointer to message information headers struct
env pointer to environment struct
Returns:
AXIS2_TRUE if http://www.w3.org/2005/08/addressing/anonymous is to be used as reply to URI, else AXIS2_FALSE

axis2_endpoint_ref_t*( * axis2_msg_info_headers_ops::get_fault_to)(const axis2_msg_info_headers_t *msg_info_headers, const axis2_env_t *env)

Gets fault to endpoint. fault to endpoint identifies the intended receiver for faults related to a message.

Parameters:
msg_info_headers pointer to message information headers struct
env pointer to environment struct
Returns:
pointer to endpoint reference representing fault to address, returns a reference, not a cloned copy

axis2_status_t( * axis2_msg_info_headers_ops::set_fault_to)(struct axis2_msg_info_headers *msg_info_headers, const axis2_env_t *env, axis2_endpoint_ref_t *fault_to)

Sets fault to endpoint. fault to endpoint identifies the intended receiver for faults related to a message.

Parameters:
msg_info_headers pointer to message information headers struct
env pointer to environment struct
fault pointer to endpoint reference representing fault to address, message information headers assumes ownership of the endpoint
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_msg_info_headers_ops::set_fault_to_none)(struct axis2_msg_info_headers *msg_info_headers, const axis2_env_t *env, const axis2_bool_t none)

Sets the bool value indicating whether the fault to endpoint should be none. fault to endpoint identifies the intended receiver for faults related to a message. The URI "http://www.w3.org/2005/08/addressing/none" in the fault to address indicates that no fault should be sent back.

Parameters:
msg_info_headers pointer to message information headers struct
env pointer to environment struct
none AXIS2_TRUE if http://www.w3.org/2005/08/addressing/none is to be used as fault to URI, else AXIS2_FALSE
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_bool_t( * axis2_msg_info_headers_ops::get_fault_to_none)(const axis2_msg_info_headers_t *msg_info_headers, const axis2_env_t *env)

Gets the bool value indicating whether the fault to endpoint should be none. fault to endpoint identifies the intended receiver for faults related to a message. The URI "http://www.w3.org/2005/08/addressing/none" in the fault to address indicates that no fault should be sent back.

Parameters:
msg_info_headers pointer to message information headers struct
env pointer to environment struct
Returns:
AXIS2_TRUE if http://www.w3.org/2005/08/addressing/none is to be used as fault to URI, else AXIS2_FALSE

axis2_status_t( * axis2_msg_info_headers_ops::set_fault_to_anonymous)(struct axis2_msg_info_headers *msg_info_headers, const axis2_env_t *env, const axis2_bool_t anonymous)

Sets the bool value indicating whether the fault to endpoint should be anonymous. fault to endpoint identifies the intended receiver for faults related to a message. The URI "http://www.w3.org/2005/08/addressing/anonymous" in the fault to address indicates that fault should be sent to from address.

Parameters:
msg_info_headers pointer to message information headers struct
env pointer to environment struct
anonymous AXIS2_TRUE if http://www.w3.org/2005/08/addressing/anonymous is to be used as fault to URI, else AXIS2_FALSE
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_bool_t( * axis2_msg_info_headers_ops::get_fault_to_anonymous)(const axis2_msg_info_headers_t *msg_info_headers, const axis2_env_t *env)

Gets the bool value indicating whether the fault to endpoint should be anonymous. fault to endpoint identifies the intended receiver for faults related to a message. The URI "http://www.w3.org/2005/08/addressing/anonymous" in the fault to address indicates that fault should be sent to from address.

Parameters:
msg_info_headers pointer to message information headers struct
env pointer to environment struct
Returns:
AXIS2_TRUE if http://www.w3.org/2005/08/addressing/anonymous is to be used as fault to URI, else AXIS2_FALSE

const axis2_char_t*( * axis2_msg_info_headers_ops::get_action)(const axis2_msg_info_headers_t *msg_info_headers, const axis2_env_t *env)

Gets WS-Addressing action. action is an absolute IRI (Internationalized Resource Identifier) that uniquely identifies the semantics implied by this message.

Parameters:
msg_info_headers pointer to message information headers struct
env pointer to environment struct
Returns:
WS-Addressing action string

axis2_status_t( * axis2_msg_info_headers_ops::set_action)(struct axis2_msg_info_headers *msg_info_headers, const axis2_env_t *env, const axis2_char_t *action)

Sets WS-Addressing action. action is an absolute IRI (Internationalized Resource Identifier) that uniquely identifies the semantics implied by this message.

Parameters:
msg_info_headers pointer to message information headers struct
env pointer to environment struct
action WS-Addressing action string
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

const axis2_char_t*( * axis2_msg_info_headers_ops::get_message_id)(const axis2_msg_info_headers_t *msg_info_headers, const axis2_env_t *env)

Gets message ID. message ID is an absolute IRI that uniquely identifies the message.

Parameters:
msg_info_headers pointer to message information headers struct
env pointer to environment struct
Returns:
message ID string.

axis2_status_t( * axis2_msg_info_headers_ops::set_message_id)(struct axis2_msg_info_headers *msg_info_headers, const axis2_env_t *env, const axis2_char_t *message_id)

Sets message ID. message ID is an absolute IRI that uniquely identifies the message.

Parameters:
msg_info_headers pointer to message information headers struct
env pointer to environment struct
message_id message ID string
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_relates_to_t*( * axis2_msg_info_headers_ops::get_relates_to)(const axis2_msg_info_headers_t *msg_info_headers, const axis2_env_t *env)

Gets relates to information.

Parameters:
msg_info_headers pointer to message information headers struct
env pointer to environment struct
Returns:
pointer to relates to struct, returns a reference, not a cloned copy
See also:
axis2_relates_to

axis2_status_t( * axis2_msg_info_headers_ops::set_relates_to)(struct axis2_msg_info_headers *msg_info_headers, const axis2_env_t *env, axis2_relates_to_t *relates_to)

Sets relates to information.

Parameters:
msg_info_headers pointer to message information headers struct
env pointer to environment struct
relates_to pointer to relates to struct, message information headers assumes ownership of struct
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_array_list_t*( * axis2_msg_info_headers_ops::get_all_ref_params)(const axis2_msg_info_headers_t *msg_info_headers, const axis2_env_t *env)

Gets all reference parameters associated with message information headers.

Parameters:
msg_info_headers pointer to message information headers struct
env pointer to environment struct
Returns:
pointer to array list containing all reference parameters

axis2_status_t( * axis2_msg_info_headers_ops::add_ref_param)(struct axis2_msg_info_headers *msg_info_headers, const axis2_env_t *env, axiom_node_t *ref_param)

Adds a reference parameter in the form of an AXIOM node.

Parameters:
msg_info_headers pointer to message information headers struct
env pointer to environment struct
ref_param pointer to AXIOM node representing reference parameter, message information header does not assume ownership of node
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_msg_info_headers_ops::free)(struct axis2_msg_info_headers *msg_info_headers, const axis2_env_t *env)

Frees message information header struct.

Parameters:
msg_info_headers pointer to message information headers struct
env pointer to environment struct
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE


The documentation for this struct was generated from the following file:
Generated on Wed Dec 20 20:14:14 2006 for Axis2/C by  doxygen 1.5.1