options
[client API]


Files

file  axis2_options.h

Classes

struct  axis2_options_ops
struct  axis2_options

Defines

#define AXIS2_DEFAULT_TIMEOUT_MILLISECONDS   30000
#define AXIS2_COPY_PROPERTIES   "copy_properties"
#define AXIS2_OPTIONS_GET_ACTION(options, env)   ((options)->ops->get_action(options, env))
#define AXIS2_OPTIONS_GET_FAULT_TO(options, env)   ((options)->ops->get_fault_to(options, env))
#define AXIS2_OPTIONS_GET_FROM(options, env)   ((options)->ops->get_from(options, env))
#define AXIS2_OPTIONS_GET_TRANSPORT_RECEIVER(options, env)   ((options)->ops->get_transport_receiver(options, env))
#define AXIS2_OPTIONS_GET_TRANSPORT_IN(options, env)   ((options)->ops->get_transport_in(options, env))
#define AXIS2_OPTIONS_GET_TRANSPORT_IN_PROTOCOL(options, env)   ((options)->ops->get_transport_in_protocol(options, env))
#define AXIS2_OPTIONS_GET_MESSAGE_ID(options, env)   ((options)->ops->get_message_id(options, env))
#define AXIS2_OPTIONS_GET_PROPERTIES(options, env)   ((options)->ops->get_properties(options, env))
#define AXIS2_OPTIONS_GET_PROPERTY(options, env, key)   ((options)->ops->get_property(options, env, key))
#define AXIS2_OPTIONS_GET_RELATES_TO(options, env)   ((options)->ops->get_relates_to(options, env))
#define AXIS2_OPTIONS_GET_REPLY_TO(options, env)   ((options)->ops->get_reply_to(options, env))
#define AXIS2_OPTIONS_GET_TRANSPORT_OUT(options, env)   ((options)->ops->get_transport_out(options, env))
#define AXIS2_OPTIONS_GET_SENDER_PROTOCOL(options, env)   ((options)->ops->get_sender_transport_protocol(options, env))
#define AXIS2_OPTIONS_GET_SOAP_VERSION_URI(options, env)   ((options)->ops->get_soap_version_uri(options, env))
#define AXIS2_OPTIONS_GET_TIMEOUT_IN_MILLI_SECONDS(options, env)   ((options)->ops->get_timeout_in_milli_seconds(options, env))
#define AXIS2_OPTIONS_GET_TO(options, env)   ((options)->ops->get_to(options, env))
#define AXIS2_OPTIONS_GET_XML_PARSER_RESET(options, env)   ((options)->ops->get_xml_parser_reset(options, env))
#define AXIS2_OPTIONS_GET_USE_SEPERATE_LISTENER(options, env)   ((options)->ops->get_use_separate_listener(options, env))
#define AXIS2_OPTIONS_GET_PARENT(options, env)   ((options)->ops->get_parent(options, env))
#define AXIS2_OPTIONS_SET_PARENT(options, env, parent)   ((options)->ops->set_parent(options, env, parent))
#define AXIS2_OPTIONS_SET_ACTION(options, env, action)   ((options)->ops->set_action(options, env, action))
#define AXIS2_OPTIONS_SET_FAULT_TO(options, env, fault_to)   ((options)->ops->set_fault_to(options, env, fault_to))
#define AXIS2_OPTIONS_SET_FROM(options, env, from)   ((options)->ops->set_from(options, env, from))
#define AXIS2_OPTIONS_SET_TO(options, env, to)   ((options)->ops->set_to(options, env, to))
#define AXIS2_OPTIONS_SET_TRANSPORT_RECEIVER(options, env, receiver)   ((options)->ops->set_transport_receiver(options, env, receiver))
#define AXIS2_OPTIONS_SET_TRANSPORT_IN(options, env, transport_in)   ((options)->ops->set_transport_in(options, env, transport_in))
#define AXIS2_OPTIONS_SET_TRANSPORT_IN_PROTOCOL(options, env, transport_in_protocol)   ((options)->ops->set_transport_in_protocol(options, env, transport_in_protocol))
#define AXIS2_OPTIONS_SET_MESSAGE_ID(options, env, message_id)   ((options)->ops->set_message_id(options, env, message_id))
#define AXIS2_OPTIONS_SET_PROPERTIES(options, env, properties)   ((options)->ops->set_properties(options, env, properties))
#define AXIS2_OPTIONS_SET_PROPERTY(options, env, key, property)   ((options)->ops->set_property(options, env, key, property))
#define AXIS2_OPTIONS_SET_RELATES_TO(options, env, relates_to)   ((options)->ops->set_relates_to(options, env, relates_to))
#define AXIS2_OPTIONS_SET_REPLY_TO(options, env, reply_to)   ((options)->ops->set_reply_to(options, env, reply_to))
#define AXIS2_OPTIONS_SET_TRANSPORT_OUT(options, env, transport_out)   ((options)->ops->set_transport_out(options, env, transport_out))
#define AXIS2_OPTIONS_SET_SENDER_TRANSPORT(options, env, sender_transport, conf)   ((options)->ops->set_sender_transport(options, env, sender_transport, conf))
#define AXIS2_OPTIONS_SET_SOAP_VERSION_URI(options, env, soap_version_uri)   ((options)->ops->set_soap_version_uri(options, env, soap_version_uri))
#define AXIS2_OPTIONS_SET_TIMEOUT_IN_MILLI_SECONDS(options, env, timeout_in_milli_seconds)   ((options)->ops->set_timeout_in_milli_seconds(options, env, timeout_in_milli_seconds))
#define AXIS2_OPTIONS_SET_TRANSPORT_INFO(options, env, sender_transport, receiver_transport, user_separate_listener)
#define AXIS2_OPTIONS_SET_USE_SEPARATE_LISTENER(options, env, use_separate_listener)   ((options)->ops->set_use_separate_listener(options, env, use_separate_listener))
#define AXIS2_OPTIONS_ADD_REFERENCE_PARAMETER(options, env, reference_parameter)   ((options)->ops->add_reference_parameter(options, env, reference_parameter))
#define AXIS2_OPTIONS_GET_MANAGE_SESSION(options, env)   ((options)->ops->get_manage_session(options, env))
#define AXIS2_OPTIONS_SET_MANAGE_SESSION(options, env, manage_session)   ((options)->ops->set_manage_session(options, env, manage_session))
#define AXIS2_OPTIONS_GET_MSG_INFO_HEADERS(options, env)   ((options)->ops->get_msg_info_headers(options, env))
#define AXIS2_OPTIONS_SET_SOAP_VERSION(options, env, soap_version)   ((options)->ops->set_soap_version(options, env, soap_version))
#define AXIS2_OPTIONS_GET_SOAP_VERSION(options, env)   ((options)->ops->get_soap_version(options, env))
#define AXIS2_OPTIONS_SET_ENABLE_MTOM(options, env, enable_mtom)   ((options)->ops->set_enable_mtom(options, env, enable_mtom))
#define AXIS2_OPTIONS_GET_ENABLE_MTOM(options, env)   ((options)->ops->get_enable_mtom(options, env))
#define AXIS2_OPTIONS_GET_SOAP_ACTION(options, env)   ((options)->ops->get_soap_action(options, env))
#define AXIS2_OPTIONS_SET_SOAP_ACTION(options, env, action)   ((options)->ops->set_soap_action(options, env, action))
#define AXIS2_OPTIONS_SET_XML_PARSER_RESET(options, env, flag)   ((options)->ops->set_xml_parser_reset(options, env, flag))
#define AXIS2_OPTIONS_FREE(options, env)   ((options)->ops->free(options, env))

Typedefs

typedef axis2_options_ops axis2_options_ops_t
typedef axis2_options axis2_options_t

Functions

AXIS2_EXTERN axis2_options_taxis2_options_create (const axis2_env_t *env)
AXIS2_EXTERN axis2_options_taxis2_options_create_with_parent (const axis2_env_t *env, axis2_options_t *parent)

Detailed Description

The options struct holds user options to be used by client when invocation services. In addition to the end point reference information, options struct also hold addressing, transport and timeout related information. User specific properties could also set on top of options.

Define Documentation

#define AXIS2_COPY_PROPERTIES   "copy_properties"

Copy properties

#define AXIS2_DEFAULT_TIMEOUT_MILLISECONDS   30000

Default timeout

#define AXIS2_OPTIONS_ADD_REFERENCE_PARAMETER ( options,
env,
reference_parameter   )     ((options)->ops->add_reference_parameter(options, env, reference_parameter))

Adds a reference parameter.

See also:
axis2_options_ops::add_reference_parameter

#define AXIS2_OPTIONS_FREE ( options,
env   )     ((options)->ops->free(options, env))

Frees the options struct.

See also:
axis2_options_ops::free

#define AXIS2_OPTIONS_GET_ACTION ( options,
env   )     ((options)->ops->get_action(options, env))

Gets WSA action.

See also:
axis2_options_ops::get_action

#define AXIS2_OPTIONS_GET_ENABLE_MTOM ( options,
env   )     ((options)->ops->get_enable_mtom(options, env))

Gets enable mtom.

See also:
axis2_options_ops::get_enable_mtom

#define AXIS2_OPTIONS_GET_FAULT_TO ( options,
env   )     ((options)->ops->get_fault_to(options, env))

Get WSA fault to address.

See also:
axis2_options_ops::get_fault_to

#define AXIS2_OPTIONS_GET_FROM ( options,
env   )     ((options)->ops->get_from(options, env))

Gets WSA from address.

See also:
axis2_options_ops::get_from

#define AXIS2_OPTIONS_GET_MANAGE_SESSION ( options,
env   )     ((options)->ops->get_manage_session(options, env))

Whether to manage session.

See also:
axis2_options_ops::get_manage_session

#define AXIS2_OPTIONS_GET_MESSAGE_ID ( options,
env   )     ((options)->ops->get_message_id(options, env))

Gets the message id.

See also:
axis2_options_ops::get_message_id

#define AXIS2_OPTIONS_GET_MSG_INFO_HEADERS ( options,
env   )     ((options)->ops->get_msg_info_headers(options, env))

Gets message information headers.

See also:
axis2_options_ops::get_msg_info_headers

#define AXIS2_OPTIONS_GET_PARENT ( options,
env   )     ((options)->ops->get_parent(options, env))

Gets the parent.

See also:
axis2_options_ops::get_parent

#define AXIS2_OPTIONS_GET_PROPERTIES ( options,
env   )     ((options)->ops->get_properties(options, env))

Gets the properties.

See also:
axis2_options_ops::get_properties

#define AXIS2_OPTIONS_GET_PROPERTY ( options,
env,
key   )     ((options)->ops->get_property(options, env, key))

Gets a property corresponding to given key.

See also:
axis2_options_ops::get_property

#define AXIS2_OPTIONS_GET_RELATES_TO ( options,
env   )     ((options)->ops->get_relates_to(options, env))

Get WSA relates to information.

See also:
axis2_options_ops::get_relates_to

#define AXIS2_OPTIONS_GET_REPLY_TO ( options,
env   )     ((options)->ops->get_reply_to(options, env))

Get WSA reply to address.

See also:
axis2_options_ops::get_reply_to

#define AXIS2_OPTIONS_GET_SENDER_PROTOCOL ( options,
env   )     ((options)->ops->get_sender_transport_protocol(options, env))

Gets the sender protocol.

See also:
axis2_options_ops::get_sender_protocol

#define AXIS2_OPTIONS_GET_SOAP_ACTION ( options,
env   )     ((options)->ops->get_soap_action(options, env))

Gets SOAP action.

See also:
axis2_options_ops::get_soap_action

#define AXIS2_OPTIONS_GET_SOAP_VERSION ( options,
env   )     ((options)->ops->get_soap_version(options, env))

Gets SOAP version.

See also:
axis2_options_ops::get_soap_version

#define AXIS2_OPTIONS_GET_SOAP_VERSION_URI ( options,
env   )     ((options)->ops->get_soap_version_uri(options, env))

Gets the soap version uri.

See also:
axis2_options_ops::get_soap_version_uri

#define AXIS2_OPTIONS_GET_TIMEOUT_IN_MILLI_SECONDS ( options,
env   )     ((options)->ops->get_timeout_in_milli_seconds(options, env))

Gets the timeout in milli seconds.

See also:
axis2_options_ops::get_timeout_in_milli_seconds

#define AXIS2_OPTIONS_GET_TO ( options,
env   )     ((options)->ops->get_to(options, env))

Get WSA to address.

See also:
axis2_options_ops::get_to

#define AXIS2_OPTIONS_GET_TRANSPORT_IN ( options,
env   )     ((options)->ops->get_transport_in(options, env))

Gets transport in.

See also:
axis2_options_ops::get_transport_in

#define AXIS2_OPTIONS_GET_TRANSPORT_IN_PROTOCOL ( options,
env   )     ((options)->ops->get_transport_in_protocol(options, env))

Gets the transport in protocol.

See also:
axis2_options_ops::get_transport_in_protocol

#define AXIS2_OPTIONS_GET_TRANSPORT_OUT ( options,
env   )     ((options)->ops->get_transport_out(options, env))

Gets the transport out.

See also:
axis2_options_ops::get_transport_out

#define AXIS2_OPTIONS_GET_TRANSPORT_RECEIVER ( options,
env   )     ((options)->ops->get_transport_receiver(options, env))

Gets the transport receiver.

See also:
axis2_options_ops::get_transport_receiver

#define AXIS2_OPTIONS_GET_USE_SEPERATE_LISTENER ( options,
env   )     ((options)->ops->get_use_separate_listener(options, env))

Whether to use a separate listener.

See also:
axis2_options_ops::get_use_separate_listener

#define AXIS2_OPTIONS_GET_XML_PARSER_RESET ( options,
env   )     ((options)->ops->get_xml_parser_reset(options, env))

Get xml parser reset value

See also:
axis2_options_opt::get_xml_parser_reset

#define AXIS2_OPTIONS_SET_ACTION ( options,
env,
action   )     ((options)->ops->set_action(options, env, action))

Sets the WSA action.

See also:
axis2_options_ops::set_action

#define AXIS2_OPTIONS_SET_ENABLE_MTOM ( options,
env,
enable_mtom   )     ((options)->ops->set_enable_mtom(options, env, enable_mtom))

Sets enable mtom.

See also:
axis2_options_ops::set_enable_mtom

#define AXIS2_OPTIONS_SET_FAULT_TO ( options,
env,
fault_to   )     ((options)->ops->set_fault_to(options, env, fault_to))

Set WSA fault to address.

See also:
axis2_options_ops::set_fault_to

#define AXIS2_OPTIONS_SET_FROM ( options,
env,
from   )     ((options)->ops->set_from(options, env, from))

Set WSA from address.

See also:
axis2_options_ops::set_from

#define AXIS2_OPTIONS_SET_MANAGE_SESSION ( options,
env,
manage_session   )     ((options)->ops->set_manage_session(options, env, manage_session))

Sets manage session.

See also:
axis2_options_ops::set_manage_session

#define AXIS2_OPTIONS_SET_MESSAGE_ID ( options,
env,
message_id   )     ((options)->ops->set_message_id(options, env, message_id))

Sets the message id.

See also:
axis2_options_ops::set_message_id

#define AXIS2_OPTIONS_SET_PARENT ( options,
env,
parent   )     ((options)->ops->set_parent(options, env, parent))

Sets the parent.

See also:
axis2_options_ops::set_parent

#define AXIS2_OPTIONS_SET_PROPERTIES ( options,
env,
properties   )     ((options)->ops->set_properties(options, env, properties))

Sets the properties.

See also:
axis2_options_ops::set_properties

#define AXIS2_OPTIONS_SET_PROPERTY ( options,
env,
key,
property   )     ((options)->ops->set_property(options, env, key, property))

Sets a property with a given key.

See also:
axis2_options_ops::set_property

#define AXIS2_OPTIONS_SET_RELATES_TO ( options,
env,
relates_to   )     ((options)->ops->set_relates_to(options, env, relates_to))

Set WSA relates to information.

See also:
axis2_options_ops::set_relates_to

#define AXIS2_OPTIONS_SET_REPLY_TO ( options,
env,
reply_to   )     ((options)->ops->set_reply_to(options, env, reply_to))

Set WSA reply to address.

See also:
axis2_options_ops::set_reply_to

#define AXIS2_OPTIONS_SET_SENDER_TRANSPORT ( options,
env,
sender_transport,
conf   )     ((options)->ops->set_sender_transport(options, env, sender_transport, conf))

Sets sender transport.

See also:
axis2_options_ops::set_sender_transport

#define AXIS2_OPTIONS_SET_SOAP_ACTION ( options,
env,
action   )     ((options)->ops->set_soap_action(options, env, action))

Sets the SOAP action.

See also:
axis2_options_ops::set_soap_action

#define AXIS2_OPTIONS_SET_SOAP_VERSION ( options,
env,
soap_version   )     ((options)->ops->set_soap_version(options, env, soap_version))

Sets SOAP version.

See also:
axis2_options_ops::set_soap_version

#define AXIS2_OPTIONS_SET_SOAP_VERSION_URI ( options,
env,
soap_version_uri   )     ((options)->ops->set_soap_version_uri(options, env, soap_version_uri))

Sets SOAP version uri.

See also:
axis2_options_ops::set_soap_version

#define AXIS2_OPTIONS_SET_TIMEOUT_IN_MILLI_SECONDS ( options,
env,
timeout_in_milli_seconds   )     ((options)->ops->set_timeout_in_milli_seconds(options, env, timeout_in_milli_seconds))

Sets timeout in milli seconds.

See also:
axis2_options_ops::set_timeout_in_milli_seconds

#define AXIS2_OPTIONS_SET_TO ( options,
env,
to   )     ((options)->ops->set_to(options, env, to))

Set WSA to address.

See also:
axis2_options_ops::set_to

#define AXIS2_OPTIONS_SET_TRANSPORT_IN ( options,
env,
transport_in   )     ((options)->ops->set_transport_in(options, env, transport_in))

Set transport in.

See also:
axis2_options_ops::set_transport_in

#define AXIS2_OPTIONS_SET_TRANSPORT_IN_PROTOCOL ( options,
env,
transport_in_protocol   )     ((options)->ops->set_transport_in_protocol(options, env, transport_in_protocol))

Sets the transport in protocol.

See also:
axis2_options_ops::set_transport_in_protocol

#define AXIS2_OPTIONS_SET_TRANSPORT_INFO ( options,
env,
sender_transport,
receiver_transport,
user_separate_listener   ) 

Value:

((options)->ops->set_tranport_info(options, env, sender_transport, \
    receiver_transport, user_separate_listener))
Sets transport information.
See also:
axis2_options_ops::set_transport_info

#define AXIS2_OPTIONS_SET_TRANSPORT_OUT ( options,
env,
transport_out   )     ((options)->ops->set_transport_out(options, env, transport_out))

Sets transport out.

See also:
axis2_options_ops::set_transport_out

#define AXIS2_OPTIONS_SET_TRANSPORT_RECEIVER ( options,
env,
receiver   )     ((options)->ops->set_transport_receiver(options, env, receiver))

Sets the transport receiver.

See also:
axis2_options_ops::set_transport_receiver

#define AXIS2_OPTIONS_SET_USE_SEPARATE_LISTENER ( options,
env,
use_separate_listener   )     ((options)->ops->set_use_separate_listener(options, env, use_separate_listener))

Sets use separate listener.

See also:
axis2_options_ops::set_use_separate_listener

#define AXIS2_OPTIONS_SET_XML_PARSER_RESET ( options,
env,
flag   )     ((options)->ops->set_xml_parser_reset(options, env, flag))

Sets xml parser reset value


Typedef Documentation

typedef struct axis2_options_ops axis2_options_ops_t

Type name for struct axis2_options_ops

typedef struct axis2_options axis2_options_t

Type name for struct axis2_options


Function Documentation

AXIS2_EXTERN axis2_options_t* axis2_options_create ( const axis2_env_t env  ) 

Creates the options struct.

Parameters:
env pointer to environment struct
Returns:
a pointer to newly created options struct, or NULL on error with error code set in environment's error.

AXIS2_EXTERN axis2_options_t* axis2_options_create_with_parent ( const axis2_env_t env,
axis2_options_t parent 
)

Creates the options struct with given parent.

Parameters:
env pointer to environment struct
parent pointer to parent struct
Returns:
a pointer to newly created options struct. Newly created options assumes ownership of the parent or NULL on error with error code set in environment's error.


Generated on Wed Dec 20 20:14:13 2006 for Axis2/C by  doxygen 1.5.1