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/15 09:01:46 UTC
svn commit: r422156 - /webservices/axis2/trunk/c/include/axis2_svc_ctx.h
Author: pini
Date: Sat Jul 15 00:01:45 2006
New Revision: 422156
URL: http://svn.apache.org/viewvc?rev=422156&view=rev
Log:
Updated doxygen comments to clean doc structure
Modified:
webservices/axis2/trunk/c/include/axis2_svc_ctx.h
Modified: webservices/axis2/trunk/c/include/axis2_svc_ctx.h
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/c/include/axis2_svc_ctx.h?rev=422156&r1=422155&r2=422156&view=diff
==============================================================================
--- webservices/axis2/trunk/c/include/axis2_svc_ctx.h (original)
+++ webservices/axis2/trunk/c/include/axis2_svc_ctx.h Sat Jul 15 00:01:45 2006
@@ -1,27 +1,31 @@
/*
- * 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_SVC_CTX_H
#define AXIS2_SVC_CTX_H
+/** @defgroup axis2_svc_ctx service context
+ * @ingroup axis2_context
+ * @{
+ */
/**
- * @file axis2_svc_ctx.h
- * @brief axis2 service context interface
- */
+ * @file axis2_svc_ctx.h
+ * @brief axis2 service context interface
+ */
#include <axis2_defines.h>
#include <axis2_env.h>
@@ -32,117 +36,183 @@
{
#endif
-/** @defgroup axis2_svc_ctx service context
- * @ingroup axis2_context
- * @{
- */
-
-typedef struct axis2_svc_ctx_ops axis2_svc_ctx_ops_t;
-typedef struct axis2_svc_ctx axis2_svc_ctx_t;
-
-
-/**
- * @brief service context ops struct
- * Encapsulator struct for ops of axis2_svc_ctx
- */
-struct axis2_svc_ctx_ops
-{
- axis2_ctx_t* (AXIS2_CALL *
- get_base)(struct axis2_svc_ctx *svc_ctx,
- const axis2_env_t *env);
-
-
- struct axis2_svc_grp_ctx* (AXIS2_CALL *
- get_parent)(struct axis2_svc_ctx *svc_ctx,
- const axis2_env_t *env);
-
-
- axis2_status_t (AXIS2_CALL *
- free)(struct axis2_svc_ctx *svc_ctx,
- const axis2_env_t *env);
-
-
+
+ /** Type name for struct axis2_svc_ctx_ops */
+ typedef struct axis2_svc_ctx_ops axis2_svc_ctx_ops_t;
+ /** Type name for struct axis2_svc_ctx */
+ typedef struct axis2_svc_ctx axis2_svc_ctx_t;
+
+
/**
- * The method is used to do the intialization of the EngineContext
+ * @brief service context ops struct
+ * Encapsulator struct for ops of axis2_svc_ctx
*/
- axis2_status_t (AXIS2_CALL *
- init)(struct axis2_svc_ctx *svc_ctx,
- const axis2_env_t *env,
- struct axis2_conf *conf);
-
-
+ struct axis2_svc_ctx_ops
+ {
+ /**
+ * @param svc_ctx pointer to service context
+ * @param env pointer to environment struct
+ */
+ axis2_ctx_t* (AXIS2_CALL *
+ get_base)(
+ struct axis2_svc_ctx *svc_ctx,
+ const axis2_env_t *env);
+
+
+ /**
+ * @param svc_ctx pointer to service context
+ * @param env pointer to environment struct
+ */
+ struct axis2_svc_grp_ctx* (AXIS2_CALL *
+ get_parent)(
+ struct axis2_svc_ctx *svc_ctx,
+ const axis2_env_t *env);
+
+
+ /**
+ * @param svc_ctx pointer to service context
+ * @param env pointer to environment struct
+ */
+ axis2_status_t (AXIS2_CALL *
+ free)(
+ struct axis2_svc_ctx *svc_ctx,
+ const axis2_env_t *env);
+
+
+ /**
+ * The method is used to do the intialization of the EngineContext
+ * @param svc_ctx pointer to service context
+ * @param env pointer to environment struct
+ * @param conf pointer to conf
+ */
+ axis2_status_t (AXIS2_CALL *
+ init)(
+ struct axis2_svc_ctx *svc_ctx,
+ const axis2_env_t *env,
+ struct axis2_conf *conf);
+
+
+ /**
+ * @param svc_ctx pointer to service context
+ * @param env pointer to environment struct
+ * @return Returns the svc_id.
+ */
+ axis2_char_t* (AXIS2_CALL *
+ get_svc_id)(
+ const struct axis2_svc_ctx *svc_ctx,
+ const axis2_env_t *env);
+
+
+ /**
+ * @param svc_ctx pointer to service context
+ * @param env pointer to environment struct
+ */
+ struct axis2_svc* (AXIS2_CALL *
+ get_svc)(
+ struct axis2_svc_ctx *svc_ctx,
+ const axis2_env_t *env);
+
+ /**
+ * @param svc_ctx pointer to service context
+ * @param env pointer to environment struct
+ * @param svc pointer to service
+ */
+ axis2_status_t (AXIS2_CALL *
+ set_svc)(
+ axis2_svc_ctx_t *svc_ctx,
+ const axis2_env_t *env,
+ struct axis2_svc *svc);
+
+
+ /**
+ * @param svc_ctx pointer to service context
+ * @param env pointer to environment struct
+ */
+ struct axis2_conf_ctx* (AXIS2_CALL *
+ get_conf_ctx)(
+ struct axis2_svc_ctx *svc_ctx,
+ const axis2_env_t *env);
+
+
+ /**
+ * @param svc_ctx pointer to service context
+ * @param env pointer to environment struct
+ * @param qname pointer to qname
+ */
+ struct axis2_op_ctx* (AXIS2_CALL *
+ create_op_ctx)(
+ struct axis2_svc_ctx *svc_ctx,
+ const axis2_env_t *env,
+ axis2_qname_t *qname);
+ };
+
/**
- * @return Returns the svc_id.
+ * service context struct
*/
- axis2_char_t* (AXIS2_CALL *
- get_svc_id)(const struct axis2_svc_ctx *svc_ctx,
- const axis2_env_t *env);
-
-
- struct axis2_svc* (AXIS2_CALL *
- get_svc)(struct axis2_svc_ctx *svc_ctx,
- const axis2_env_t *env);
-
- axis2_status_t (AXIS2_CALL *
- set_svc) (axis2_svc_ctx_t *svc_ctx,
- const axis2_env_t *env,
- struct axis2_svc *svc);
-
-
- struct axis2_conf_ctx* (AXIS2_CALL *
- get_conf_ctx)(struct axis2_svc_ctx *svc_ctx,
- const axis2_env_t *env);
-
-
- struct axis2_op_ctx* (AXIS2_CALL *
- create_op_ctx)(struct axis2_svc_ctx *svc_ctx,
- const axis2_env_t *env,
- axis2_qname_t *qname);
-};
-
-/**
- * @brief service context struct
- * Axis2 service context
- */
-struct axis2_svc_ctx
-{
- axis2_svc_ctx_ops_t *ops;
-};
+ struct axis2_svc_ctx
+ {
+ /** operations of service context */
+ axis2_svc_ctx_ops_t *ops;
+ };
+
+ /**
+ * Creates a service context struct
+ * @paraam env pointer to environment struct
+ * @param svc pointer to service
+ * @param svc_grp_ctx pointer to service group context
+ */
+ AXIS2_EXTERN axis2_svc_ctx_t* AXIS2_CALL axis2_svc_ctx_create(const axis2_env_t *env,
+ struct axis2_svc *svc,
+ struct axis2_svc_grp_ctx *svc_grp_ctx);
-AXIS2_EXTERN axis2_svc_ctx_t* AXIS2_CALL axis2_svc_ctx_create(const axis2_env_t *env,
- struct axis2_svc *svc,
- struct axis2_svc_grp_ctx *svc_grp_ctx);
-
/************************** Start of function macros **************************/
+/** Gets the base.
+ @sa axis2_svc_ctx_ops#get_svc */
#define AXIS2_SVC_CTX_GET_BASE(svc_ctx, env) \
((svc_ctx)->ops->get_base(svc_ctx, env))
-
+
+/** Gets the parent.
+ @sa axis2_svc_ctx_ops#get_svc */
#define AXIS2_SVC_CTX_GET_PARENT(svc_ctx, env) \
((svc_ctx)->ops->get_parent(svc_ctx, env))
-
+
+/** Frees the service context.
+ @sa axis2_svc_ctx_ops#get_svc */
#define AXIS2_SVC_CTX_FREE(svc_ctx, env) \
((svc_ctx)->ops->free(svc_ctx, env))
-
+
+/** Initialize the service context.
+ @sa axis2_svc_ctx_ops#get_svc */
#define AXIS2_SVC_CTX_INIT(svc_ctx, env, conf) \
((svc_ctx)->ops->init(svc_ctx, env, conf))
-
+
+/** Gets the service id.
+ @sa axis2_svc_ctx_ops#get_svc */
#define AXIS2_SVC_CTX_GET_SVC_ID(svc_ctx, env) \
((svc_ctx)->ops->get_svc_id(svc_ctx, env))
-
+
+/** Gets the service.
+ @sa axis2_svc_ctx_ops#get_svc */
#define AXIS2_SVC_CTX_GET_SVC(svc_ctx, env) \
((svc_ctx)->ops->get_svc(svc_ctx, env))
-
+
+/** Sets the service.
+ @sa axis2_svc_ctx_ops#get_svc */
#define AXIS2_SVC_CTX_SET_SVC(svc_ctx, env, svc) \
((svc_ctx)->ops->set_svc(svc_ctx, env, svc))
-
+
+/** Gets the configuratoin context.
+ @sa axis2_svc_ctx_ops#get_svc */
#define AXIS2_SVC_CTX_GET_CONF_CTX(svc_ctx, env) \
((svc_ctx)->ops->get_conf_ctx(svc_ctx, env))
-
+
+/** Creates the operations context.
+ @sa axis2_svc_ctx_ops#get_svc */
#define AXIS2_SVC_CTX_CREATE_OP_CTX(svc_ctx, env, qname) \
((svc_ctx)->ops->create_op_ctx(svc_ctx, env, qname))
-
-/************************** 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