You are viewing a plain text version of this content. The canonical link for it is here.
Posted to axis-cvs@ws.apache.org by pi...@apache.org on 2006/07/12 08:08:13 UTC
svn commit: r421152 - /webservices/axis2/trunk/c/include/axis2_options.h
Author: pini
Date: Tue Jul 11 23:08:13 2006
New Revision: 421152
URL: http://svn.apache.org/viewvc?rev=421152&view=rev
Log:
Updated doxygen comments to clean doc structure
Modified:
webservices/axis2/trunk/c/include/axis2_options.h
Modified: webservices/axis2/trunk/c/include/axis2_options.h
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/c/include/axis2_options.h?rev=421152&r1=421151&r2=421152&view=diff
==============================================================================
--- webservices/axis2/trunk/c/include/axis2_options.h (original)
+++ webservices/axis2/trunk/c/include/axis2_options.h Tue Jul 11 23:08:13 2006
@@ -1,22 +1,26 @@
/*
- * Copyright 2004,2005 The Apache Software Foundation.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
+* Copyright 2004,2005 The Apache Software Foundation.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+* http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
#ifndef AXIS2_OPTIONS_H
#define AXIS2_OPTIONS_H
+/** @defgroup axis2_options options
+ * @ingroup axis2_client_api
+ * @{
+ */
/**
* @file axis2_options.h
@@ -34,7 +38,9 @@
#include <axiom_element.h>
#include <axis2_msg_info_headers.h>
+/** define default timeout */
#define AXIS2_DEFAULT_TIMEOUT_MILLISECONDS 30000
+/** copy properties */
#define AXIS2_COPY_PROPERTIES "copy_properties"
#ifdef __cplusplus
@@ -42,437 +48,721 @@
{
#endif
-/** @defgroup axis2_options options
- * @ingroup axis2_client_api
- * @{
- */
-
-typedef struct axis2_options_ops axis2_options_ops_t;
-typedef struct axis2_options axis2_options_t;
-
-/**
- * @brief Options ops struct
- * Encapsulator struct for ops of axis2_options
- */
-struct axis2_options_ops
-{
- axis2_char_t* (AXIS2_CALL *
- get_action)(struct axis2_options *options,
- const axis2_env_t *env);
-
-
- axis2_endpoint_ref_t* (AXIS2_CALL *
- get_fault_to)(struct axis2_options *options,
- const axis2_env_t *env);
-
-
- axis2_endpoint_ref_t* (AXIS2_CALL *
- get_from)(struct axis2_options *options,
- const axis2_env_t *env);
-
- axis2_transport_receiver_t* (AXIS2_CALL *
- get_transport_receiver)(struct axis2_options *options,
- const axis2_env_t *env);
-
-
- axis2_transport_in_desc_t* (AXIS2_CALL *
- get_transport_in)(struct axis2_options *options,
- const axis2_env_t *env);
-
- const axis2_char_t* (AXIS2_CALL *
- get_transport_in_protocol)(struct axis2_options *options,
- const axis2_env_t *env);
-
- axis2_char_t* (AXIS2_CALL *
- get_message_id)(struct axis2_options *options,
- const axis2_env_t *env);
-
- axis2_hash_t* (AXIS2_CALL *
- get_properties)(struct axis2_options *options,
- const axis2_env_t *env);
+ /** Type name for struct axis2_options_ops */
+ typedef struct axis2_options_ops axis2_options_ops_t;
+ /** Type name for struct axis2_options */
+ typedef struct axis2_options axis2_options_t;
/**
- * @param key
- * @return the value realeted to this key. Null, if not found.
- */
- void* (AXIS2_CALL *
- get_property)(struct axis2_options *options,
- const axis2_env_t *env,
- axis2_char_t *key);
-
- axis2_relates_to_t* (AXIS2_CALL *
- get_relates_to)(struct axis2_options *options,
- const axis2_env_t *env);
-
-
- axis2_endpoint_ref_t* (AXIS2_CALL *
- get_reply_to)(struct axis2_options *options,
- const axis2_env_t *env);
-
- axis2_transport_out_desc_t* (AXIS2_CALL *
- get_transport_out)(struct axis2_options *options,
- const axis2_env_t *env);
-
- axis2_char_t* (AXIS2_CALL *
- get_sender_transport_protocol)(struct axis2_options *options,
- const axis2_env_t *env);
-
- const axis2_char_t* (AXIS2_CALL *
- get_soap_version_uri)(struct axis2_options *options,
- const axis2_env_t *env);
-
-
- /**
- * Gets the wait time after which a client times out in a blocking scenario.
- * The default is AXIS2_DEFAULT_TIMEOUT_MILLISECONDS
- *
- * @return timeOutInMilliSeconds
+ * @brief Options ops struct
+ * Encapsulator struct for ops of axis2_options
*/
- long (AXIS2_CALL *
- get_timeout_in_milli_seconds)(struct axis2_options *options,
- const axis2_env_t *env);
-
- axis2_endpoint_ref_t* (AXIS2_CALL *
- get_to)(struct axis2_options *options,
- const axis2_env_t *env);
-
- /**not added - is_exception_to_be_thrown_on_soap_fault*/
-
- axis2_bool_t (AXIS2_CALL *
- is_use_seperate_listener)(struct axis2_options *options,
- const axis2_env_t *env);
-
- struct axis2_options * (AXIS2_CALL *
- get_parent)(struct axis2_options *options,
- const axis2_env_t *env);
-
- void (AXIS2_CALL *
- set_parent)(struct axis2_options *options,
- const axis2_env_t *env,
- const axis2_options_t *parent);
-
- void (AXIS2_CALL *
- set_action)(struct axis2_options *options,
- const axis2_env_t *env,
- const axis2_char_t *action);
-
- void (AXIS2_CALL *
- set_fault_to)(struct axis2_options *options,
- const axis2_env_t *env,
- axis2_endpoint_ref_t *fault_to);
-
- void (AXIS2_CALL *
- set_from)(struct axis2_options *options,
- const axis2_env_t *env,
- axis2_endpoint_ref_t *from);
-
- void (AXIS2_CALL *
- set_to)(struct axis2_options *options,
- const axis2_env_t *env,
- axis2_endpoint_ref_t *to);
-
- void (AXIS2_CALL *
- set_transport_receiver)(struct axis2_options *options,
- const axis2_env_t *env,
- axis2_transport_receiver_t *receiver);
-
- void (AXIS2_CALL *
- set_transport_in)(struct axis2_options *options,
- const axis2_env_t *env,
- axis2_transport_in_desc_t *transport_in);
+ struct axis2_options_ops
+ {
+ /**
+ *@param options pointer to options struct
+ *@param env pointer to environment struct
+ */
+ axis2_char_t* (AXIS2_CALL *
+ get_action)(struct axis2_options *options,
+ const axis2_env_t *env);
+
+ /**
+ *@param options pointer to options struct
+ *@param env pointer to environment struct
+ */
+ axis2_endpoint_ref_t* (AXIS2_CALL *
+ get_fault_to)(struct axis2_options *options,
+ const axis2_env_t *env);
+
+ /**
+ *@param options pointer to options struct
+ *@param env pointer to environment struct
+ */
+ axis2_endpoint_ref_t* (AXIS2_CALL *
+ get_from)(struct axis2_options *options,
+ const axis2_env_t *env);
+
+ /**
+ *@param options pointer to options struct
+ *@param env pointer to environment struct
+ */
+ axis2_transport_receiver_t* (AXIS2_CALL *
+ get_transport_receiver)(struct axis2_options *options,
+ const axis2_env_t *env);
+
+
+ /**
+ *@param options pointer to options struct
+ *@param env pointer to environment struct
+ */
+ axis2_transport_in_desc_t* (AXIS2_CALL *
+ get_transport_in)(struct axis2_options *options,
+ const axis2_env_t *env);
+
+ /**
+ *@param options pointer to options struct
+ *@param env pointer to environment struct
+ */
+ const axis2_char_t* (AXIS2_CALL *
+ get_transport_in_protocol)(struct axis2_options *options,
+ const axis2_env_t *env);
+
+ /**
+ *@param options pointer to options struct
+ *@param env pointer to environment struct
+ */
+ axis2_char_t* (AXIS2_CALL *
+ get_message_id)(struct axis2_options *options,
+ const axis2_env_t *env);
+
+ /**
+ *@param options pointer to options struct
+ *@param env pointer to environment struct
+ */
+ axis2_hash_t* (AXIS2_CALL *
+ get_properties)(struct axis2_options *options,
+ const axis2_env_t *env);
+
+ /**
+ * @param options pointer to options struct
+ * @param env pointer to environment struct
+ * @return key return the value realeted to this key. Null, if not found.
+ */
+ void* (AXIS2_CALL *
+ get_property)(struct axis2_options *options,
+ const axis2_env_t *env,
+ axis2_char_t *key);
+
+ /**
+ *@param options pointer to options struct
+ *@param env pointer to environment struct
+ */
+ axis2_relates_to_t* (AXIS2_CALL *
+ get_relates_to)(struct axis2_options *options,
+ const axis2_env_t *env);
+
+
+ /**
+ *@param options pointer to options struct
+ *@param env pointer to environment struct
+ */
+ axis2_endpoint_ref_t* (AXIS2_CALL *
+ get_reply_to)(struct axis2_options *options,
+ const axis2_env_t *env);
+
+ /**
+ *@param options pointer to options struct
+ *@param env pointer to environment struct
+ */
+ axis2_transport_out_desc_t* (AXIS2_CALL *
+ get_transport_out)(struct axis2_options *options,
+ const axis2_env_t *env);
+
+ /**
+ *@param options pointer to options struct
+ *@param env pointer to environment struct
+ */
+ axis2_char_t* (AXIS2_CALL *
+ get_sender_transport_protocol)(struct axis2_options *options,
+ const axis2_env_t *env);
+
+ /**
+ *@param options pointer to options struct
+ *@param env pointer to environment struct
+ */
+ const axis2_char_t* (AXIS2_CALL *
+ get_soap_version_uri)(struct axis2_options *options,
+ const axis2_env_t *env);
+
+
+ /**
+ * Gets the wait time after which a client times out in a blocking scenario.
+ * The default is AXIS2_DEFAULT_TIMEOUT_MILLISECONDS
+ * @param options pointer to options struct
+ * @param env pointer to environment struct
+ * @return timeOutInMilliSeconds
+ */
+ long (AXIS2_CALL *
+ get_timeout_in_milli_seconds)(struct axis2_options *options,
+ const axis2_env_t *env);
+
+ /**
+ * @param options pointer to options struct
+ * @param env pointer to environment struct
+ */
+ axis2_endpoint_ref_t* (AXIS2_CALL *
+ get_to)(struct axis2_options *options,
+ const axis2_env_t *env);
+
+ /**
+ * not added - is_exception_to_be_thrown_on_soap_fault
+ * @param options pointer to options struct
+ * @param env pointer to environment struct
+ */
+ axis2_bool_t (AXIS2_CALL *
+ is_use_seperate_listener)(struct axis2_options *options,
+ const axis2_env_t *env);
+
+ /**
+ * @param options pointer to options struct
+ * @param env pointer to environment struct
+ */
+ struct axis2_options * (AXIS2_CALL *
+ get_parent)(struct axis2_options *options,
+ const axis2_env_t *env);
+ /**
+ * @param options pointer to options struct
+ * @param env pointer to environment struct
+ * @param parent pointer to parent struct
+ */
+ void (AXIS2_CALL *
+ set_parent)(struct axis2_options *options,
+ const axis2_env_t *env,
+ const axis2_options_t *parent);
+ /**
+ * @param options pointer to options struct
+ * @param env pointer to environment struct
+ * @param action pointer to action struct
+ */
+ void (AXIS2_CALL *
+ set_action)(struct axis2_options *options,
+ const axis2_env_t *env,
+ const axis2_char_t *action);
+
+ /**
+ * @param options pointer to options struct
+ * @param env pointer to environment struct
+ * @param fault_to pointer to fault_to struct
+ */
+ void (AXIS2_CALL *
+ set_fault_to)(struct axis2_options *options,
+ const axis2_env_t *env,
+ axis2_endpoint_ref_t *fault_to);
+
+ /**
+ * @param options pointer to options struct
+ * @param env pointer to environment struct
+ * @param from pointer to from struct
+ */
+ void (AXIS2_CALL *
+ set_from)(struct axis2_options *options,
+ const axis2_env_t *env,
+ axis2_endpoint_ref_t *from);
- void (AXIS2_CALL *
- set_transport_in_protocol)(struct axis2_options *options,
+ /**
+ * @param options pointer to options struct
+ * @param env pointer to environment struct
+ * @param to pointer to to struct
+ */
+ void (AXIS2_CALL *
+ set_to)(struct axis2_options *options,
+ const axis2_env_t *env,
+ axis2_endpoint_ref_t *to);
+ /**
+ * @param options pointer to options struct
+ * @param env pointer to environment struct
+ * @param receiver pointer to receiver struct
+ */
+ void (AXIS2_CALL *
+ set_transport_receiver)(struct axis2_options *options,
+ const axis2_env_t *env,
+ axis2_transport_receiver_t *receiver);
+
+ /**
+ * @param options pointer to options struct
+ * @param env pointer to environment struct
+ * @param transport_in pointer to transport_in struct
+ */
+ void (AXIS2_CALL *
+ set_transport_in)(struct axis2_options *options,
+ const axis2_env_t *env,
+ axis2_transport_in_desc_t *transport_in);
+
+ /**
+ * @param options pointer to options struct
+ * @param env pointer to environment struct
+ * @param in_protocol pointer to in_protocol struct
+ */
+ void (AXIS2_CALL *
+ set_transport_in_protocol)(struct axis2_options *options,
const axis2_env_t *env,
axis2_char_t *transport_in_protocol);
-
- void (AXIS2_CALL *
- set_message_id)(struct axis2_options *options,
- const axis2_env_t *env,
- axis2_char_t *message_id);
+ /**
+ * @param options pointer to options struct
+ * @param env pointer to environment struct
+ * @param message_id pointer to message_id struct
+ */
+ void (AXIS2_CALL *
+ set_message_id)(struct axis2_options *options,
+ const axis2_env_t *env,
+ axis2_char_t *message_id);
+
-
- /**
- * This will set the properties to the context. But in setting that one may
- * need to "copy" all the properties from the source properties to the
- * target properties. To enable this we introduced a property
- * AXIS2_COPY_PROPERTIES so that if set to
- * Boolean(true), this code will copy the whole thing, without just
- * referencing to the source.
- *
- * @param properties
- */
- axis2_status_t (AXIS2_CALL *
- set_properties)(struct axis2_options *options,
- const axis2_env_t *env,
- axis2_hash_t *properties);
-
- /**
- * Properties you need to pass in to the message context must be set via
- * this. If there is a method to the set this property, within this class,
- * its encouraged to use that method, without duplicating stuff or making
- * room for bugs.
- *
- * @param property_key
- * @param property
- */
- void (AXIS2_CALL *
- set_property)(struct axis2_options *options,
- const axis2_env_t *env,
- const axis2_char_t *property_key,
- const void *property);
-
-
- void (AXIS2_CALL *
- set_relates_to)(struct axis2_options *options,
- const axis2_env_t *env,
- axis2_relates_to_t *relates_to);
-
- void (AXIS2_CALL *
- set_reply_to)(struct axis2_options *options,
- const axis2_env_t *env,
- axis2_endpoint_ref_t *reply_to);
-
- void (AXIS2_CALL *
- set_transport_out)(struct axis2_options *options,
- const axis2_env_t *env,
- axis2_transport_out_desc_t *transport_out);
-
- axis2_status_t (AXIS2_CALL *
- set_sender_transport)(struct axis2_options *options,
- const axis2_env_t *env,
- axis2_char_t *sender_transport,
- axis2_conf_t *conf);
-
- void (AXIS2_CALL *
- set_soap_version_uri)(struct axis2_options *options,
- const axis2_env_t *env,
- const axis2_char_t *soap_version_uri);
-
- void (AXIS2_CALL *
- set_timeout_in_milli_seconds)(struct axis2_options *options,
- const axis2_env_t *env,
- long timeout_in_milli_seconds);
-
-
- axis2_status_t (AXIS2_CALL *
- set_transport_info)(struct axis2_options *options,
- const axis2_env_t *env,
- axis2_char_t *sender_transport,
- axis2_char_t *receiver_transport,
- axis2_bool_t use_seperate_listener);
+ /**
+ * This will set the properties to the context. But in setting that one may
+ * need to "copy" all the properties from the source properties to the
+ * target properties. To enable this we introduced a property
+ * AXIS2_COPY_PROPERTIES so that if set to
+ * Boolean(true), this code will copy the whole thing, without just
+ * referencing to the source.
+ * @param options pointer to options struct
+ * @param env pointer to environment struct
+ * @param properties pointer to properties struct
+ */
+ axis2_status_t (AXIS2_CALL *
+ set_properties)(struct axis2_options *options,
+ const axis2_env_t *env,
+ axis2_hash_t *properties);
+
+ /**
+ * Properties you need to pass in to the message context must be set via
+ * this. If there is a method to the set this property, within this class,
+ * its encouraged to use that method, without duplicating stuff or making
+ * room for bugs.
+ * @param options pointer to options struct
+ * @param env pointer to environment struct
+ * @param property_key pointer to property_key struct
+ * @param property pointer to property struct
+ */
+ void (AXIS2_CALL *
+ set_property)(struct axis2_options *options,
+ const axis2_env_t *env,
+ const axis2_char_t *property_key,
+ const void *property);
- void (AXIS2_CALL *
- set_use_seperate_listener)(struct axis2_options *options,
+ /**
+ * @param options pointer to options struct
+ * @param env pointer to environment struct
+ * @param relates_to pointer to relates_to struct
+ */
+ void (AXIS2_CALL *
+ set_relates_to)(struct axis2_options *options,
+ const axis2_env_t *env,
+ axis2_relates_to_t *relates_to);
+
+ /**
+ * @param options pointer to options struct
+ * @param env pointer to environment struct
+ * @param reply_to pointer to reply_to struct
+ */
+ void (AXIS2_CALL *
+ set_reply_to)(struct axis2_options *options,
+ const axis2_env_t *env,
+ axis2_endpoint_ref_t *reply_to);
+
+ /**
+ * @param options pointer to options struct
+ * @param env pointer to environment struct
+ * @param transport_out pointer to transport_out struct
+ */
+ void (AXIS2_CALL *
+ set_transport_out)(struct axis2_options *options,
+ const axis2_env_t *env,
+ axis2_transport_out_desc_t *transport_out);
+
+ /**
+ * @param options pointer to options struct
+ * @param env pointer to environment struct
+ * param @sender_transport pointer to sender_transport struct
+ * @param conf pointer to conf struct
+ */
+ axis2_status_t (AXIS2_CALL *
+ set_sender_transport)(struct axis2_options *options,
+ const axis2_env_t *env,
+ axis2_char_t *sender_transport,
+ axis2_conf_t *conf);
+
+ /**
+ * @param options pointer to options struct
+ * @param env pointer to environment struct
+ * @param soap_version_uri pointer to soap_version_uri struct
+ */
+ void (AXIS2_CALL *
+ set_soap_version_uri)(struct axis2_options *options,
+ const axis2_env_t *env,
+ const axis2_char_t *soap_version_uri);
+
+ /**
+ * @param options pointer to options struct
+ * @param env pointer to environment struct
+ * @timeout_in_milli_seconds pointer to timeout
+ */
+ void (AXIS2_CALL *
+ set_timeout_in_milli_seconds)(struct axis2_options *options,
+ const axis2_env_t *env,
+ long timeout_in_milli_seconds);
+
+ /**
+ * @param options pointer to options struct
+ * @param env pointer to environment struct
+ * @param sender_transport pointer to sender_transport struct
+ * @param receiver_transport pointer to receiver_transport struct
+ * @param use_seperate_listener pointer to use_seperate_listener struct
+ */
+ axis2_status_t (AXIS2_CALL *
+ set_transport_info)(struct axis2_options *options,
+ const axis2_env_t *env,
+ axis2_char_t *sender_transport,
+ axis2_char_t *receiver_transport,
+ axis2_bool_t use_seperate_listener);
+
+ /**
+ * @param options pointer to options struct
+ * @param env pointer to environment struct
+ * @param use_seperate_listener pointer to use_seperate_listener
+ */
+ void (AXIS2_CALL *
+ set_use_seperate_listener)(struct axis2_options *options,
const axis2_env_t *env,
axis2_bool_t use_seperate_listener);
- void (AXIS2_CALL *
- add_reference_parameter)(struct axis2_options *options,
- const axis2_env_t *env,
- axiom_node_t *reference_parameter);
-
- axis2_bool_t (AXIS2_CALL *
- is_manage_session)(struct axis2_options *options,
- const axis2_env_t *env);
-
-
- void (AXIS2_CALL *
- set_manage_session)(struct axis2_options *options,
- const axis2_env_t *env,
- axis2_bool_t manage_session);
-
- /**
- * this method is used to set the msg info headers to msg ctx. not
- * intended to be used from outside
+ /**
+ * @param options pointer to options struct
+ * @param env pointer to environment struct
+ * @param reference_parameter pointer to reference parameter
+ */
+ void (AXIS2_CALL *
+ add_reference_parameter)(struct axis2_options *options,
+ const axis2_env_t *env,
+ axiom_node_t *reference_parameter);
+
+ /**
+ * @param options pointer to options struct
+ * @param env pointer to environment struct
+ */
+ axis2_bool_t (AXIS2_CALL *
+ is_manage_session)(struct axis2_options *options,
+ const axis2_env_t *env);
+
+ /**
+ * @param options pointer to options struct
+ * @param env pointer to environment struct
+ * @param manage_session pointer to manage_session pointer
+ */
+ void (AXIS2_CALL *
+ set_manage_session)(struct axis2_options *options,
+ const axis2_env_t *env,
+ axis2_bool_t manage_session);
+
+ /**
+ * this method is used to set the msg info headers to msg ctx. not
+ * intended to be used from outside
+ * @param options pointer to options struct
+ * @param env pointer to environment struct
+ */
+ axis2_msg_info_headers_t* (AXIS2_CALL *
+ get_msg_info_headers)(struct axis2_options *options,
+ const axis2_env_t *env);
+
+ /**
+ * @param options pointer to options struct
+ * @param env pointer to environment struct
+ */
+ int (AXIS2_CALL *
+ get_soap_version)(
+ struct axis2_options *options,
+ const axis2_env_t *env);
+
+ /**
+ * @param options pointer to options struct
+ * @param env pointer to environment struct
+ * @param soap_version soap version
+ */
+ axis2_status_t (AXIS2_CALL *
+ set_soap_version)(
+ struct axis2_options *options,
+ const axis2_env_t *env,
+ int soap_version);
+
+ /**
+ * @param options pointer to options struct
+ * @param env pointer to environment struct
+ * @param enable_mtom enable mtom
+ */
+ axis2_status_t (AXIS2_CALL *
+ set_enable_mtom)(
+ struct axis2_options *options,
+ const axis2_env_t *env,
+ axis2_bool_t enable_mtom);
+
+ /**
+ * @param options pointer to options struct
+ * @param env pointer to environment struct
+ */
+ axis2_bool_t (AXIS2_CALL *
+ get_enable_mtom)(
+ struct axis2_options *options,
+ const axis2_env_t *env);
+
+ /**
+ * @param options pointer to options struct
+ * @param env pointer to environment struct
+ */
+ axis2_status_t (AXIS2_CALL *
+ free)(struct axis2_options *options,
+ const axis2_env_t *env);
+ };
+
+ /**
+ * options struct
*/
- axis2_msg_info_headers_t* (AXIS2_CALL *
- get_msg_info_headers)(struct axis2_options *options,
- const axis2_env_t *env);
-
- int (AXIS2_CALL *
- get_soap_version)(
- struct axis2_options *options,
- const axis2_env_t *env);
-
- axis2_status_t (AXIS2_CALL *
- set_soap_version)(
- struct axis2_options *options,
- const axis2_env_t *env,
- int soap_version);
-
- axis2_status_t (AXIS2_CALL *
- set_enable_mtom)(
- struct axis2_options *options,
- const axis2_env_t *env,
- axis2_bool_t enable_mtom);
-
- axis2_bool_t (AXIS2_CALL *
- get_enable_mtom)(
- struct axis2_options *options,
- const axis2_env_t *env);
-
- axis2_status_t (AXIS2_CALL *
- free)(struct axis2_options *options,
- const axis2_env_t *env);
-};
-
-/**
- * @brief Options struct
- * Axis2 Options
- */
-struct axis2_options
-{
- axis2_options_ops_t *ops;
-};
+ struct axis2_options
+ {
+ /** options of options struct */
+ axis2_options_ops_t *ops;
+ };
-AXIS2_EXTERN axis2_options_t* AXIS2_CALL axis2_options_create(const axis2_env_t *env);
+ /**
+ * Creates the options struct
+ * @param env pointer to environment struct
+ * return 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_CALL axis2_options_create(const axis2_env_t *env);
+ /**
+ * @param env pointer to environment struct
+ * @param parent pointer to parent struct
+ * @return 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_CALL axis2_options_create_with_parent(const axis2_env_t *env,
+ axis2_options_t *parent);
-AXIS2_EXTERN axis2_options_t* AXIS2_CALL axis2_options_create_with_parent(const axis2_env_t *env,
- axis2_options_t *parent);
-
-/************************** Start of function macros **************************/
+ /************************** Start of function macros **************************/
+/** Gets action.
+ @sa axis2_options_ops#get_action */
#define AXIS2_OPTIONS_GET_ACTION(options, env) \
((options)->ops->get_action(options, env))
-
+
+/** Get fault to.
+ @sa axis2_options_ops#get_fault_to */
#define AXIS2_OPTIONS_GET_FAULT_TO(options, env) \
((options)->ops->get_fault_to(options, env))
+/** Gets from.
+ @sa axis2_options_ops#get_from */
#define AXIS2_OPTIONS_GET_FROM(options, env) \
((options)->ops->get_from(options, env))
+/** Gets the transport receiver.
+ @sa axis2_options_ops#get_transport_receiver */
#define AXIS2_OPTIONS_GET_TRANSPORT_RECEIVER(options, env) \
((options)->ops->get_transport_receiver(options, env))
+/** Gets transport in.
+ @sa axis2_options_ops#get_tranport_in */
#define AXIS2_OPTIONS_GET_TRANSPORT_IN(options, env) \
- ((options)->ops->get_transport_in(options, env))
+ ((options)->ops->get_transport_in(options, env))
+/** Gets the transport in protocol.
+ @sa axis2_options_ops#get_transport_in_protocol */
#define AXIS2_OPTIONS_GET_TRANSPORT_IN_PROTOCOL(options, env) \
((options)->ops->get_transport_in_protocol(options, env))
+/** Gets the message id.
+ @sa axis2_options_ops#get_message_id */
#define AXIS2_OPTIONS_GET_MESSAGE_ID(options, env) \
((options)->ops->get_message_id(options, env))
+/** Gets the properties.
+ @sa axis2_options_ops#get_properties */
#define AXIS2_OPTIONS_GET_PROPERTIES(options, env) \
((options)->ops->get_properties(options, env))
+/** Get the property.
+ @sa axis2_options_ops#get_property */
#define AXIS2_OPTIONS_GET_PROPERTY(options, env, key) \
((options)->ops->get_property(options, env, key))
+/** Get relates to.
+ @sa axis2_options_ops#get_relates_to */
#define AXIS2_OPTIONS_GET_RELATES_TO(options, env) \
((options)->ops->get_relates_to(options, env))
+/** Get reply to.
+ @sa axis2_options_ops#get_reply_to */
#define AXIS2_OPTIONS_GET_REPLY_TO(options, env) \
((options)->ops->get_reply_to(options, env))
+/** Gets the transport out.
+ @sa axis2_options_ops#get_transport_out */
#define AXIS2_OPTIONS_GET_TRANSPORT_OUT(options, env) \
((options)->ops->get_transport_out(options, env))
+/** Gets the sender protocol.
+ @sa axis2_options_ops#get_sender_protocol */
#define AXIS2_OPTIONS_GET_SENDER_PROTOCOL(options, env) \
((options)->ops->get_sender_transport_protocol(options, env))
+/** Gets the soap version uri.
+ @sa axis2_options_ops#get_soap_version_uri */
#define AXIS2_OPTIONS_GET_SOAP_VERSION_URI(options, env) \
((options)->ops->get_soap_version_uri(options, env))
+/** Gets the timeout in milli seconds.
+ @sa axis2_options_ops#get_timeout_in_milli_seconds */
#define AXIS2_OPTIONS_GET_TIMEOUT_IN_MILLI_SECONDS(options, env) \
((options)->ops->get_timeout_in_milli_seconds(options, env))
+/** Get to.
+ @sa axis2_options_ops#get_to */
#define AXIS2_OPTIONS_GET_TO(options, env) \
((options)->ops->get_to(options, env))
+/** Whether to use a seperate listener.
+ @sa axis2_options_ops#is_use_seperate_listener */
#define AXIS2_OPTIONS_IS_USE_SEPERATE_LISTENER(options, env) \
((options)->ops->is_use_seperate_listener(options, env))
+/** Gets the parent.
+ @sa axis2_options_ops#get_parent */
#define AXIS2_OPTIONS_GET_PARENT(options, env) \
((options)->ops->get_parent(options, env))
+/** Sets the parent.
+ @sa axis2_options_ops#set_parent */
#define AXIS2_OPTIONS_SET_PARENT(options, env, parent) \
((options)->ops->set_parent(options, env, parent))
+/** Sets the action.
+ @sa axis2_options_ops#set_action */
#define AXIS2_OPTIONS_SET_ACTION(options, env, action) \
((options)->ops->set_action(options, env, action))
+/** Set fault to.
+ @sa axis2_options_ops#set_fault_to */
#define AXIS2_OPTIONS_SET_FAULT_TO(options, env, fault_to) \
((options)->ops->set_fault_to(options, env, fault_to))
+/** Set from.
+ @sa axis2_options_ops#set_from */
#define AXIS2_OPTIONS_SET_FROM(options, env, from) \
((options)->ops->set_from(options, env, from))
+/** Set to.
+ @sa axis2_options_ops#set_to */
#define AXIS2_OPTIONS_SET_TO(options, env, to) \
((options)->ops->set_to(options, env, to))
+/** Sets the transport receiver.
+ @sa axis2_options_ops#set_transport_receiver */
#define AXIS2_OPTIONS_SET_TRANSPORT_RECEIVER(options, env, receiver) \
((options)->ops->set_transport_receiver(options, env, receiver))
+/** Set transport in.
+ @sa axis2_options_ops#set_transport_in */
#define AXIS2_OPTIONS_SET_TRANSPORT_IN(options, env, transport_in) \
((options)->ops->set_transport_in(options, env, transport_in))
+/** Sets the transport in protocol.
+ @sa axis2_options_ops#set_transport_in_protocol */
#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 message id.
+ @sa axis2_options_ops#set_message_id */
#define AXIS2_OPTIONS_SET_MESSAGE_ID(options, env, message_id) \
((options)->ops->set_message_id(options, env, message_id))
+/** Sets the properties.
+ @sa axis2_options_ops#set_properties */
#define AXIS2_OPTIONS_SET_PROPERTIES(options, env, properties) \
((options)->ops->set_properties(options, env, properties))
+/** Sets the property.
+ @sa axis2_options_ops#set_property */
#define AXIS2_OPTIONS_SET_PROPERTY(options, env, key, property) \
((options)->ops->set_property(options, env, key, property))
+/** Set relates to.
+ @sa axis2_options_ops#set_relates_to */
#define AXIS2_OPTIONS_SET_RELATES_TO(options, env, relates_to) \
((options)->ops->set_relates_to(options, env, relates_to))
+/** Set reply to.
+ @sa axis2_options_ops#set_reply_to */
#define AXIS2_OPTIONS_SET_REPLY_TO(options, env, reply_to) \
((options)->ops->set_reply_to(options, env, reply_to))
-
+
+/** Sets the transport out.
+ @sa axis2_options_ops#set_transport_out */
#define AXIS2_OPTIONS_SET_TRANSPORT_OUT(options, env, transport_out) \
((options)->ops->set_transport_out(options, env, transport_out))
+/** Sets the sender transport.
+ @sa axis2_options_ops#set_sender_transport */
#define AXIS2_OPTIONS_SET_SENDER_TRANSPORT(options, env, sender_transport, conf) \
((options)->ops->set_sender_transport(options, env, sender_transport, conf))
+/** Sets the soap version uri.
+ @sa 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 the timeout in milli seconds.
+ @sa axis2_options_ops#set_timeout_in_milli_seconds */
#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 the transport info.
+ @sa axis2_options_ops#set_trasnport_info */
#define AXIS2_OPTIONS_SET_TRANSPORT_INFO(options, env, sender_transport, receiver_transport, user_seperate_listener) \
((options)->ops->set_tranport_info(options, env, sender_transport, receiver_transport, user_seperate_listener))
+/** Sets the use seperate listener.
+ @sa axis2_options_ops#set_use_seperate_listener */
#define AXIS2_OPTIONS_SET_USE_SEPERATE_LISTENER(options, env, use_seperate_listener) \
((options)->ops->set_use_seperate_listener(options, env, use_seperate_listener))
+/** Adds the reference parameter.
+ @sa axis2_options_ops#add_reference_parameter */
#define AXIS2_OPTIONS_ADD_REFERENCE_PARAMETER(options, env, reference_parameter) \
((options)->ops->add_reference_parameter(options, env, reference_parameter))
+/** Whether to manage session.
+ @sa axis2_options_ops#is_manage_session */
#define AXIS2_OPTIONS_IS_MANAGE_SESSION(options, env) \
((options)->ops->is_manage_session(options, env))
+/** Sets manage session.
+ @sa axis2_options_ops#set_manage_session*/
#define AXIS2_OPTIONS_SET_MANAGE_SESSION(options, env, manage_session) \
((options)->ops->set_manage_session(options, env, manage_session))
+/** Gets the message info headers.
+ @sa axis2_options_ops#get_msg_info_headers */
#define AXIS2_OPTIONS_GET_MSG_INFO_HEADERS(options, env) \
((options)->ops->get_msg_info_headers(options, env))
+/** Sets the soap version.
+ @sa axis2_options_ops#set_soap_version */
#define AXIS2_OPTIONS_SET_SOAP_VERSION(options, env, soap_version) \
((options)->ops->set_soap_version(options, env, soap_version))
+/** Gets the soap version.
+ @sa axis2_options_ops#get_soap_version */
#define AXIS2_OPTIONS_GET_SOAP_VERSION(options, env) \
((options)->ops->get_soap_version(options, env))
+/** set enable mtom.
+ @sa axis2_options_ops#set_enable_mtom */
#define AXIS2_OPTIONS_SET_ENABLE_MTOM(options, env, enable_mtom) \
((options)->ops->set_enable_mtom(options, env, enable_mtom))
+/** get enable mtom.
+ @sa axis2_options_ops#get_enable_mtom */
#define AXIS2_OPTIONS_GET_ENABLE_MTOM(options, env) \
((options)->ops->get_enable_mtom(options, env))
+/** Free.
+ @sa axis2_options_ops#free*/
#define AXIS2_OPTIONS_FREE(options, env) \
((options)->ops->free(options, env))
-/************************** End of function macros ****************************/
+/************************** End of function macros ****************************/
/** @} */
#ifdef __cplusplus
---------------------------------------------------------------------
To unsubscribe, e-mail: axis-cvs-unsubscribe@ws.apache.org
For additional commands, e-mail: axis-cvs-help@ws.apache.org