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 sa...@apache.org on 2006/09/16 03:53:38 UTC
svn commit: r446806 - in /webservices/axis2/trunk/c:
include/axis2_relates_to.h modules/core/addr/relates_to.c
Author: samisa
Date: Fri Sep 15 18:53:36 2006
New Revision: 446806
URL: http://svn.apache.org/viewvc?view=rev&rev=446806
Log:
Fixd doc comments and API
Modified:
webservices/axis2/trunk/c/include/axis2_relates_to.h
webservices/axis2/trunk/c/modules/core/addr/relates_to.c
Modified: webservices/axis2/trunk/c/include/axis2_relates_to.h
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/c/include/axis2_relates_to.h?view=diff&rev=446806&r1=446805&r2=446806
==============================================================================
--- webservices/axis2/trunk/c/include/axis2_relates_to.h (original)
+++ webservices/axis2/trunk/c/include/axis2_relates_to.h Fri Sep 15 18:53:36 2006
@@ -17,17 +17,23 @@
#ifndef AXIS2_RELATES_TO_H
#define AXIS2_RELATES_TO_H
-/**
- * @file axis2_relates_to.h
- * @brief Axis2 core addressing interface
- */
/**
* @defgroup axis2_relates_to relates to
* @ingroup axis2_addr
+ * relates to encapsulates data that indicate how a message relates to
+ * another message.
+ * The related message is identified by a URI that corresponds to the
+ * related message's message ID. The type of the relationship is also captured
+ * by relates to. Basically relates to handles the following WS-Addressing
+ * header <wsa:RelatesTo RelationshipType="..."?>xs:anyURI</wsa:RelatesTo>
* @{
*/
+/**
+ * @file axis2_relates_to.h
+ */
+
#include <axis2_defines.h>
#include <axis2_env.h>
#include <axis2_const.h>
@@ -44,54 +50,63 @@
/**
- * Dispatcher ops struct
+ * relates to ops struct.
*/
struct axis2_relates_to_ops
{
/**
- * @param relates_to relates to
+ * Gets value. The value field represents the URI that corresponds to the
+ * related message's message ID
+ * @param relates_to pointer to relates to struct
* @param env pointer to environment struct
+ * @return value string
*/
- axis2_char_t *(AXIS2_CALL *
+ const axis2_char_t *(AXIS2_CALL *
get_value)(
const axis2_relates_to_t *relates_to,
const axis2_env_t *env);
/**
- * @param relates_to relates to
+ * Sets value. The value field represents the URI that corresponds to the
+ * related message's message ID
+ * @param relates_to pointer to relates to struct
* @param env pointer to environment struct
- * @param value pointer to value
+ * @param value value string
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
axis2_status_t (AXIS2_CALL *
set_value)(
struct axis2_relates_to *relates_to,
const axis2_env_t *env,
- axis2_char_t *value);
+ const axis2_char_t *value);
/**
- * @param relates_to relates to
+ * Gets relationship type.
+ * @param relates_to pointer to relates to struct
* @param env pointer to environment struct
+ * @return relationship type string
*/
- axis2_char_t *(AXIS2_CALL *
+ const axis2_char_t *(AXIS2_CALL *
get_relationship_type)(
const axis2_relates_to_t *relates_to,
const axis2_env_t *env);
/**
- * @param relates_to relates to
+ * Sets relationship type.
+ * @param relates_to pointer to relates to struct
* @param env pointer to environment struct
- * @param relationship_type pointer to relationship type
+ * @param relationship_type relationship type string
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
axis2_status_t (AXIS2_CALL *
set_relationship_type)(
struct axis2_relates_to *relates_to,
const axis2_env_t *env,
- axis2_char_t *relationship_type);
+ const axis2_char_t *relationship_type);
/**
- * @param relates_to relates to
+ * Frees relates to struct.
+ * @param relates_to pointer to relates to struct
* @param env pointer to environment struct
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
@@ -102,20 +117,20 @@
};
/**
- * Dispatcher struct
+ * relates to struct.
*/
struct axis2_relates_to
{
- /** Dispatcher related ops */
+ /** relates to ops */
axis2_relates_to_ops_t *ops;
};
/**
- * creates relates_to struct
+ * creates relates to struct.
* @param env pointer to environment struct
- * @param value pointer to value
- * @param relationship_type pointer to relationship type
+ * @param value value string
+ * @param relationship_type relationship type string
*/
AXIS2_EXTERN axis2_relates_to_t *AXIS2_CALL
axis2_relates_to_create(
@@ -123,27 +138,27 @@
const axis2_char_t *value,
const axis2_char_t *relationship_type);
-/** Get value.
+/** Gets value.
@sa axis2_relates_to_ops#get_value */
#define AXIS2_RELATES_TO_GET_VALUE(relates_to, env) \
((relates_to)->ops->get_value(relates_to, env))
-/** Set value.
+/** Sets value.
@sa axis2_relates_to_ops#set_value */
#define AXIS2_RELATES_TO_SET_VALUE(relates_to, env, vlaue) \
((relates_to)->ops->set_value(relates_to, env, vlaue))
-/** Gets the relationship type.
+/** Gets relationship type.
@sa axis2_relates_to_ops#get_relationship */
#define AXIS2_RELATES_TO_GET_RELATIONSHIP_TYPE(relates_to, env) \
((relates_to)->ops->get_relationship_type(relates_to, env))
-/** Sets the relationship type.
+/** Sets relationship type.
@sa axis2_relates_to_ops#set_relationship */
#define AXIS2_RELATES_TO_SET_RELATIONSHIP_TYPE(relates_to, env, relationship_type) \
((relates_to)->ops->set_relationship_type(relates_to, env, relationship_type))
-/** Free.
+/** Frees relates to struct.
@sa axis2_relates_to_ops#free */
#define AXIS2_RELATES_TO_FREE(relates_to, env) \
((relates_to)->ops->free(relates_to, env))
Modified: webservices/axis2/trunk/c/modules/core/addr/relates_to.c
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/c/modules/core/addr/relates_to.c?view=diff&rev=446806&r1=446805&r2=446806
==============================================================================
--- webservices/axis2/trunk/c/modules/core/addr/relates_to.c (original)
+++ webservices/axis2/trunk/c/modules/core/addr/relates_to.c Fri Sep 15 18:53:36 2006
@@ -14,26 +14,23 @@
* limitations under the License.
*/
- /** <wsa:RelatesTo RelationshipType="..."?>xs:anyURI</wsa:RelatesTo> */
-
#include <axis2_relates_to.h>
#include <axis2_string.h>
typedef struct axis2_relates_to_impl
{
axis2_relates_to_t relates_to;
- /** value */
+ /** value string */
axis2_char_t *value;
- /** relationship type */
+ /** relationship type string */
axis2_char_t *relationship_type;
-}
-axis2_relates_to_impl_t;
+} axis2_relates_to_impl_t;
/** Interface to implementation conversion macro */
#define AXIS2_INTF_TO_IMPL(relates_to) ((axis2_relates_to_impl_t *)relates_to)
-axis2_char_t *AXIS2_CALL
+const axis2_char_t *AXIS2_CALL
axis2_relates_to_get_value(
const axis2_relates_to_t *relates_to,
const axis2_env_t *env);
@@ -42,9 +39,9 @@
axis2_relates_to_set_value(
struct axis2_relates_to *relates_to,
const axis2_env_t *env,
- axis2_char_t *value);
+ const axis2_char_t *value);
-axis2_char_t *AXIS2_CALL
+const axis2_char_t *AXIS2_CALL
axis2_relates_to_get_relationship_type(
const axis2_relates_to_t *relates_to,
const axis2_env_t *env);
@@ -53,7 +50,7 @@
axis2_relates_to_set_relationship_type(
struct axis2_relates_to *relates_to,
const axis2_env_t *env,
- axis2_char_t *relationship_type);
+ const axis2_char_t *relationship_type);
axis2_status_t AXIS2_CALL
axis2_relates_to_free(
@@ -130,7 +127,7 @@
return &(relates_to_impl->relates_to);
}
-axis2_char_t *AXIS2_CALL
+const axis2_char_t *AXIS2_CALL
axis2_relates_to_get_value(
const axis2_relates_to_t *relates_to,
const axis2_env_t *env)
@@ -143,7 +140,7 @@
axis2_relates_to_set_value(
struct axis2_relates_to *relates_to,
const axis2_env_t *env,
- axis2_char_t *value)
+ const axis2_char_t *value)
{
axis2_relates_to_impl_t *relates_to_impl = NULL;
@@ -170,7 +167,7 @@
return AXIS2_SUCCESS;
}
-axis2_char_t *AXIS2_CALL
+const axis2_char_t *AXIS2_CALL
axis2_relates_to_get_relationship_type(
const axis2_relates_to_t *relates_to,
const axis2_env_t *env)
@@ -183,7 +180,7 @@
axis2_relates_to_set_relationship_type(
struct axis2_relates_to *relates_to,
const axis2_env_t *env,
- axis2_char_t *relationship_type)
+ const axis2_char_t *relationship_type)
{
axis2_relates_to_impl_t *relates_to_impl = NULL;
---------------------------------------------------------------------
To unsubscribe, e-mail: axis-cvs-unsubscribe@ws.apache.org
For additional commands, e-mail: axis-cvs-help@ws.apache.org