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/11 11:26:18 UTC
svn commit: r420773 - /webservices/axis2/trunk/c/include/axis2_stub.h
Author: pini
Date: Tue Jul 11 02:26:17 2006
New Revision: 420773
URL: http://svn.apache.org/viewvc?rev=420773&view=rev
Log:
Updated doxygen comments to clean doc structure
Modified:
webservices/axis2/trunk/c/include/axis2_stub.h
Modified: webservices/axis2/trunk/c/include/axis2_stub.h
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/c/include/axis2_stub.h?rev=420773&r1=420772&r2=420773&view=diff
==============================================================================
--- webservices/axis2/trunk/c/include/axis2_stub.h (original)
+++ webservices/axis2/trunk/c/include/axis2_stub.h Tue Jul 11 02:26:17 2006
@@ -1,163 +1,229 @@
/*
- * 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_STUB_H
#define AXIS2_STUB_H
+/** @defgroup axis2_stub stub
+ * @ingroup axis2_client_api
+ * description
+ * @{
+ */
+
+/**
+ * @file axis2_stub.h
+ * @brief Axis2c service skeleton that should be implemented by actual service
+ * wrappers
+ */
+
#include <axis2_endpoint_ref.h>
#include <axis2_svc_client.h>
#include <axis2_options.h>
#include <axiom_xml_reader.h>
#include <axis2_property.h>
+/** definition soap 11 */
+#define AXIOM_SOAP_11 0
+/** definition soap 12 */
+#define AXIOM_SOAP_12 1
#ifdef __cplusplus
extern "C"
{
#endif
-
-/**
- * @file axis2_stub.h
- * @brief Axis2c service skeleton that should be implemented by actual service
- * wrappers
- */
-/** @defgroup axis2_stub stub
- * @ingroup axis2_client_api
- * @{
- */
-
-#define AXIOM_SOAP_11 0
-#define AXIOM_SOAP_12 1
+ /** Type name for struct axis2_stub_ops */
+ typedef struct axis2_stub_ops axis2_stub_ops_t;
+ /** Type name for struct axis2_stub */
+ typedef struct axis2_stub axis2_stub_t;
-typedef struct axis2_stub_ops axis2_stub_ops_t;
-typedef struct axis2_stub axis2_stub_t;
+ /**
+ * service client ops struct.
+ * Encapsulator struct for operations of axis2_svc_client
+ */
-AXIS2_DECLARE_DATA struct axis2_stub_ops
-{
- axis2_status_t (AXIS2_CALL *
- free)(axis2_stub_t *stub,
- const axis2_env_t *env);
-
- axis2_status_t (AXIS2_CALL *
- set_endpoint_ref) (axis2_stub_t *stub,
+ AXIS2_DECLARE_DATA struct axis2_stub_ops
+ {
+ /**
+ * @param stub pointer to stub struct
+ * @param env pointer to environment struct
+ * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+ */
+ axis2_status_t (AXIS2_CALL *
+ free)(axis2_stub_t *stub,
+ const axis2_env_t *env);
+
+ /**
+ * @param stub pointer to stub struct
+ * @param env pointer to environment struct
+ * @param enpoint_ref pointer to enpoint reference
+ * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+ */
+ axis2_status_t (AXIS2_CALL *
+ set_endpoint_ref) (axis2_stub_t *stub,
const axis2_env_t *env,
axis2_endpoint_ref_t *endpoint_ref);
-
- axis2_status_t (AXIS2_CALL *
- set_endpoint_uri) (axis2_stub_t *stub,
+
+ /**
+ * @param stub pointer to stub struct
+ * @param env pointer to environment struct
+ * @param enpoint_uri pointer to endpoint uri
+ * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+ */
+ axis2_status_t (AXIS2_CALL *
+ set_endpoint_uri) (axis2_stub_t *stub,
const axis2_env_t *env,
axis2_char_t *endpoint_uri);
-
-
- /**
- *
- * @param use_separate_transport
- */
- axis2_status_t (AXIS2_CALL *
- set_use_seperate_listener)(axis2_stub_t *stub,
+
+
+ /**
+ * @param stub pointer to stub struct
+ * @param env pointer to environment struct
+ * @param use_seperate listener
+ * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+ */
+ axis2_status_t (AXIS2_CALL *
+ set_use_seperate_listener)(axis2_stub_t *stub,
const axis2_env_t *env,
axis2_bool_t use_separate_listener);
-
- /**
- * Set the soap version
- * @param soap_version
- */
- axis2_status_t (AXIS2_CALL *
- set_soap_version)(axis2_stub_t *stub,
+
+ /**
+ * @param stub pointer to stub struct
+ * @param env pointer to environment struct
+ * @param soap_version
+ * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+ */
+ axis2_status_t (AXIS2_CALL *
+ set_soap_version)(axis2_stub_t *stub,
const axis2_env_t *env,
int soap_version);
-
-
- axis2_char_t *(AXIS2_CALL *
- get_svc_ctx_id)(axis2_stub_t *stub,
- const axis2_env_t *env);
-
-
- axis2_status_t (AXIS2_CALL *
- engage_module)(axis2_stub_t *stub,
- const axis2_env_t *env,
- axis2_char_t *module_name);
-
- axis2_svc_client_t *(AXIS2_CALL *
- get_svc_client)(axis2_stub_t *stub,
- const axis2_env_t *env);
-
- axis2_options_t *(AXIS2_CALL *
- get_options)(axis2_stub_t *stub,
- const axis2_env_t *env);
-} ;
-AXIS2_DECLARE_DATA struct axis2_stub
-{
- axis2_stub_ops_t *ops;
-};
+ /**
+ * @param stub pointer to stub struct
+ * @param env pointer to environment struct
+ */
+ axis2_char_t *(AXIS2_CALL *
+ get_svc_ctx_id)(axis2_stub_t *stub,
+ const axis2_env_t *env);
+
+
+ /**
+ * @param stub pointer to stub struct
+ * @param env pointer to environment struct
+ * @param module_name pointer to module_name struct
+ * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+ */
+ axis2_status_t (AXIS2_CALL *
+ engage_module)(axis2_stub_t *stub,
+ const axis2_env_t *env,
+ axis2_char_t *module_name);
-/**
- * Creates axis2_stub struct
- * @param endpoint reference
- * @return pointer to newly created axis2_stub struct
- */
-AXIS2_EXTERN axis2_stub_t * AXIS2_CALL
-axis2_stub_create_with_endpoint_ref_and_client_home(const axis2_env_t *env,
- axis2_endpoint_ref_t *endpoint_ref,
- const axis2_char_t *client_home);
+ /**
+ * @param stub pointer to stub struct
+ * @param env pointer to environment struct
+ */
+ axis2_svc_client_t *(AXIS2_CALL *
+ get_svc_client)(axis2_stub_t *stub,
+ const axis2_env_t *env);
+
+ /**
+ * @param stub pointer to stub struct
+ * @param env pointer to environment struct
+ */
+ axis2_options_t *(AXIS2_CALL *
+ get_options)(axis2_stub_t *stub,
+ const axis2_env_t *env);
+
+ } ;
+
+ AXIS2_DECLARE_DATA struct axis2_stub
+ {
+ axis2_stub_ops_t *ops;
+ };
-/**
- * Creates axis2_stub struct
- * @param endpoint uri
- * @return pointer to newly created axis2_stub struct
- */
-AXIS2_EXTERN axis2_stub_t * AXIS2_CALL
-axis2_stub_create_with_endpoint_uri_and_client_home(const axis2_env_t *env,
- const axis2_char_t *endpoint_uri,
- const axis2_char_t *client_home);
+ /**
+ * Creates axis2_stub struct
+ * @param endpoint reference
+ * @return pointer to newly created axis2_stub struct
+ */
+ AXIS2_EXTERN axis2_stub_t * AXIS2_CALL
+ axis2_stub_create_with_endpoint_ref_and_client_home(const axis2_env_t *env,
+ axis2_endpoint_ref_t *endpoint_ref,
+ const axis2_char_t *client_home);
+
+ /**
+ * Creates axis2_stub struct
+ * @param endpoint uri
+ * @return pointer to newly created axis2_stub struct
+ */
+ AXIS2_EXTERN axis2_stub_t * AXIS2_CALL
+ axis2_stub_create_with_endpoint_uri_and_client_home(const axis2_env_t *env,
+ const axis2_char_t *endpoint_uri,
+ const axis2_char_t *client_home);
/*************************** Function macros **********************************/
+/** Frees the axis2 stub.
+ @sa axis2_stub_ops#free */
#define AXIS2_STUB_FREE(stub, env) \
((stub)->ops->free (stub, env))
+/** Sets the end point reference.
+ @sa axis2_stub_ops#set_endpoint_ref*/
#define AXIS2_STUB_SET_ENDPOINT_REF(stub, env, endpoint_ref) \
((stub)->ops->set_endpoint_ref (stub, env, endpoint_ref))
+/** Sets the end point uri.
+ @sa axis2_stub_ops#set_endpoint_uri*/
#define AXIS2_STUB_SET_ENDPOINT_URI(stub, env, endpoint_uri) \
((stub)->ops->set_endpoint_uri (stub, env, endpoint_uri))
-
+
+/** Sets the use seperate listener.
+ @sa axis2_stub_ops#set_use_seperate_listener*/
#define AXIS2_STUB_SET_USE_SEPERATE_LISTENER(stub, env, use_separate_listener) \
- ((stub)->ops->set_transport_info (stub, env, use_separate_listener))
+ ((stub)->ops->set_transport_info (stub, env, use_separate_listener))
+/** Engages the module.
+ @sa axis2_stub_ops#engage_module*/
#define AXIS2_STUB_ENGAGE_MODULE(stub, env, module_name) \
((stub)->ops->engage_module (stub, env, module_name))
-
+
+/** Sets the soap version.
+ @sa axis2_stub_ops#set_soap_version*/
#define AXIS2_STUB_SET_SOAP_VERSION(stub, env, soap_version) \
((stub)->ops->set_soap_version (stub, env, soap_version))
-
+
+/** Gets the service context id
+ @sa axis2_stub_ops#get_svc_ctx_id*/
#define AXIS2_STUB_GET_SVC_CTX_ID(stub, env) \
((stub)->ops->get_svc_ctx_id (stub, env))
-
+
+/** Gets the service client
+ @sa axis2_stub_ops#get_svc_client*/
#define AXIS2_STUB_GET_SVC_CLIENT(stub, env) \
((stub)->ops->get_svc_client(stub, env))
+/** Gets the options
+ @sa axis2_stub_ops#get_options*/
#define AXIS2_STUB_GET_OPTIONS(stub, env) \
((stub)->ops->get_options(stub, env))
-
-
-/** @} */
+
+
+ /** @} */
#ifdef __cplusplus
}
---------------------------------------------------------------------
To unsubscribe, e-mail: axis-cvs-unsubscribe@ws.apache.org
For additional commands, e-mail: axis-cvs-help@ws.apache.org