You are viewing a plain text version of this content. The canonical link for it is here.
Posted to java-dev@axis.apache.org by sa...@apache.org on 2007/09/28 11:47:13 UTC
svn commit: r580274 [5/8] - /webservices/axis2/trunk/c/include/
Modified: webservices/axis2/trunk/c/include/axis2_msg_info_headers.h
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/c/include/axis2_msg_info_headers.h?rev=580274&r1=580273&r2=580274&view=diff
==============================================================================
--- webservices/axis2/trunk/c/include/axis2_msg_info_headers.h (original)
+++ webservices/axis2/trunk/c/include/axis2_msg_info_headers.h Fri Sep 28 02:47:09 2007
@@ -1,3 +1,4 @@
+
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
@@ -21,17 +22,17 @@
/**
* @defgroup axis2_msg_info_headers message information headers
* @ingroup axis2_addr
- * message information headers encapsulates properties that enable the
- * identification and location of the endpoints involved in an interaction.
- * The basic interaction pattern from which all others are composed is
- * "one way". In this pattern a source sends a message to a destination
- * without any further definition of the interaction. "Request Reply" is a
- * common interaction pattern that consists of an initial message sent by
- * a source endpoint (the request) and a subsequent message sent from the
- * destination of the request back to the source (the reply).
+ * message information headers encapsulates properties that enable the
+ * identification and location of the endpoints involved in an interaction.
+ * The basic interaction pattern from which all others are composed is
+ * "one way". In this pattern a source sends a message to a destination
+ * without any further definition of the interaction. "Request Reply" is a
+ * common interaction pattern that consists of an initial message sent by
+ * a source endpoint (the request) and a subsequent message sent from the
+ * destination of the request back to the source (the reply).
* A reply can be either an application message, a fault, or any other message.
* message information headers capture addressing information related to these
- * interaction patterns such as from, to, reply to and fault to addresses.
+ * interaction patterns such as from, to, reply to and fault to addresses.
* @{
*/
@@ -61,10 +62,11 @@
* @return pointer to newly created message information headers struct
*/
AXIS2_EXTERN axis2_msg_info_headers_t *AXIS2_CALL
+
axis2_msg_info_headers_create(
- const axutil_env_t *env,
- axis2_endpoint_ref_t *to,
- const axis2_char_t *action);
+ const axutil_env_t * env,
+ axis2_endpoint_ref_t * to,
+ const axis2_char_t * action);
/**
* Gets to endpoint. to endpoint represents the address of the
@@ -75,8 +77,10 @@
* returns a reference, not a cloned copy
*/
AXIS2_EXTERN axis2_endpoint_ref_t *AXIS2_CALL
- axis2_msg_info_headers_get_to(const axis2_msg_info_headers_t *msg_info_headers,
- const axutil_env_t *env);
+
+ axis2_msg_info_headers_get_to(
+ const axis2_msg_info_headers_t * msg_info_headers,
+ const axutil_env_t * env);
/**
* Sets to endpoint. to endpoint represents the address of the
@@ -88,25 +92,28 @@
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
- axis2_msg_info_headers_set_to(struct axis2_msg_info_headers *msg_info_headers,
- const axutil_env_t *env,
- axis2_endpoint_ref_t *to);
+ axis2_msg_info_headers_set_to(
+ struct axis2_msg_info_headers *msg_info_headers,
+ const axutil_env_t * env,
+ axis2_endpoint_ref_t * to);
/**
* Gets from endpoint. from endpoint represents the address of the
- * endpoint where the message originated from.
+ * endpoint where the message originated from.
* @param msg_info_headers pointer to message information headers struct
* @param env pointer to environment struct
* @return pointer to endpoint reference representing from address,
* returns a reference, not a cloned copy
*/
AXIS2_EXTERN axis2_endpoint_ref_t *AXIS2_CALL
- axis2_msg_info_headers_get_from(const axis2_msg_info_headers_t *msg_info_headers,
- const axutil_env_t *env);
+
+ axis2_msg_info_headers_get_from(
+ const axis2_msg_info_headers_t * msg_info_headers,
+ const axutil_env_t * env);
/**
* Sets from endpoint. from endpoint represents the address of the
- * endpoint where the message originated from.
+ * endpoint where the message originated from.
* @param msg_info_headers pointer to message information headers struct
* @param env pointer to environment struct
* @param from pointer to endpoint reference representing from address,
@@ -114,9 +121,10 @@
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
- axis2_msg_info_headers_set_from(struct axis2_msg_info_headers *msg_info_headers,
- const axutil_env_t *env,
- axis2_endpoint_ref_t *from);
+ axis2_msg_info_headers_set_from(
+ struct axis2_msg_info_headers *msg_info_headers,
+ const axutil_env_t * env,
+ axis2_endpoint_ref_t * from);
/**
* Gets reply to endpoint. reply to endpoint identifies the intended
@@ -127,8 +135,10 @@
* returns a reference, not a cloned copy
*/
AXIS2_EXTERN axis2_endpoint_ref_t *AXIS2_CALL
- axis2_msg_info_headers_get_reply_to(const axis2_msg_info_headers_t *msg_info_headers,
- const axutil_env_t *env);
+
+ axis2_msg_info_headers_get_reply_to(
+ const axis2_msg_info_headers_t * msg_info_headers,
+ const axutil_env_t * env);
/**
* Sets reply to endpoint. reply to endpoint identifies the intended
@@ -140,9 +150,11 @@
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
- axis2_msg_info_headers_set_reply_to(struct axis2_msg_info_headers *msg_info_headers,
- const axutil_env_t *env,
- axis2_endpoint_ref_t *reply_to);
+
+ axis2_msg_info_headers_set_reply_to(
+ struct axis2_msg_info_headers *msg_info_headers,
+ const axutil_env_t * env,
+ axis2_endpoint_ref_t * reply_to);
/**
* Sets the bool value indicating whether the reply to endpoint should
@@ -156,8 +168,10 @@
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
- axis2_msg_info_headers_set_reply_to_none(struct axis2_msg_info_headers *msg_info_headers,
- const axutil_env_t *env,
+
+ axis2_msg_info_headers_set_reply_to_none(
+ struct axis2_msg_info_headers *msg_info_headers,
+ const axutil_env_t * env,
const axis2_bool_t none);
/**
@@ -172,8 +186,10 @@
* is to be used as reply to URI, else AXIS2_FALSE
*/
AXIS2_EXTERN axis2_bool_t AXIS2_CALL
- axis2_msg_info_headers_get_reply_to_none(const axis2_msg_info_headers_t *msg_info_headers,
- const axutil_env_t *env);
+
+ axis2_msg_info_headers_get_reply_to_none(
+ const axis2_msg_info_headers_t * msg_info_headers,
+ const axutil_env_t * env);
/**
* Sets the bool value indicating whether the reply to endpoint should
@@ -190,8 +206,10 @@
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
- axis2_msg_info_headers_set_reply_to_anonymous(struct axis2_msg_info_headers *msg_info_headers,
- const axutil_env_t *env,
+
+ axis2_msg_info_headers_set_reply_to_anonymous(
+ struct axis2_msg_info_headers *msg_info_headers,
+ const axutil_env_t * env,
const axis2_bool_t anonymous);
/**
@@ -207,8 +225,10 @@
* is to be used as reply to URI, else AXIS2_FALSE
*/
AXIS2_EXTERN axis2_bool_t AXIS2_CALL
- axis2_msg_info_headers_get_reply_to_anonymous(const axis2_msg_info_headers_t *msg_info_headers,
- const axutil_env_t *env);
+
+ axis2_msg_info_headers_get_reply_to_anonymous(
+ const axis2_msg_info_headers_t * msg_info_headers,
+ const axutil_env_t * env);
/**
* Gets fault to endpoint. fault to endpoint identifies the intended
@@ -216,11 +236,13 @@
* @param msg_info_headers pointer to message information headers struct
* @param env pointer to environment struct
* @return pointer to endpoint reference representing fault to address,
- * returns a reference, not a cloned copy
+ * returns a reference, not a cloned copy
*/
AXIS2_EXTERN axis2_endpoint_ref_t *AXIS2_CALL
- axis2_msg_info_headers_get_fault_to(const axis2_msg_info_headers_t *msg_info_headers,
- const axutil_env_t *env);
+
+ axis2_msg_info_headers_get_fault_to(
+ const axis2_msg_info_headers_t * msg_info_headers,
+ const axutil_env_t * env);
/**
* Sets fault to endpoint. fault to endpoint identifies the intended
@@ -232,9 +254,11 @@
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
- axis2_msg_info_headers_set_fault_to(struct axis2_msg_info_headers *msg_info_headers,
- const axutil_env_t *env,
- axis2_endpoint_ref_t *fault_to);
+
+ axis2_msg_info_headers_set_fault_to(
+ struct axis2_msg_info_headers *msg_info_headers,
+ const axutil_env_t * env,
+ axis2_endpoint_ref_t * fault_to);
/**
* Sets the bool value indicating whether the fault to endpoint should
@@ -249,8 +273,10 @@
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
- axis2_msg_info_headers_set_fault_to_none(struct axis2_msg_info_headers *msg_info_headers,
- const axutil_env_t *env,
+
+ axis2_msg_info_headers_set_fault_to_none(
+ struct axis2_msg_info_headers *msg_info_headers,
+ const axutil_env_t * env,
const axis2_bool_t none);
/**
@@ -265,8 +291,10 @@
* is to be used as fault to URI, else AXIS2_FALSE
*/
AXIS2_EXTERN axis2_bool_t AXIS2_CALL
- axis2_msg_info_headers_get_fault_to_none(const axis2_msg_info_headers_t *msg_info_headers,
- const axutil_env_t *env);
+
+ axis2_msg_info_headers_get_fault_to_none(
+ const axis2_msg_info_headers_t * msg_info_headers,
+ const axutil_env_t * env);
/**
* Sets the bool value indicating whether the fault to endpoint should
@@ -283,8 +311,10 @@
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
- axis2_msg_info_headers_set_fault_to_anonymous(struct axis2_msg_info_headers *msg_info_headers,
- const axutil_env_t *env,
+
+ axis2_msg_info_headers_set_fault_to_anonymous(
+ struct axis2_msg_info_headers *msg_info_headers,
+ const axutil_env_t * env,
const axis2_bool_t anonymous);
/**
@@ -293,15 +323,17 @@
* faults related to a message. The URI
* "http://www.w3.org/2005/08/addressing/anonymous"
* in the fault to address indicates that fault should be sent to
- * from address.
+ * from address.
* @param msg_info_headers pointer to message information headers struct
* @param env pointer to environment struct
* @return AXIS2_TRUE if http://www.w3.org/2005/08/addressing/anonymous
* is to be used as fault to URI, else AXIS2_FALSE
*/
AXIS2_EXTERN axis2_bool_t AXIS2_CALL
- axis2_msg_info_headers_get_fault_to_anonymous(const axis2_msg_info_headers_t *msg_info_headers,
- const axutil_env_t *env);
+
+ axis2_msg_info_headers_get_fault_to_anonymous(
+ const axis2_msg_info_headers_t * msg_info_headers,
+ const axutil_env_t * env);
/**
* Gets WS-Addressing action. action is an absolute IRI
@@ -312,8 +344,10 @@
* @return WS-Addressing action string
*/
AXIS2_EXTERN const axis2_char_t *AXIS2_CALL
- axis2_msg_info_headers_get_action(const axis2_msg_info_headers_t *msg_info_headers,
- const axutil_env_t *env);
+
+ axis2_msg_info_headers_get_action(
+ const axis2_msg_info_headers_t * msg_info_headers,
+ const axutil_env_t * env);
/**
* Sets WS-Addressing action. action is an absolute IRI
@@ -325,9 +359,10 @@
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
- axis2_msg_info_headers_set_action(struct axis2_msg_info_headers *msg_info_headers,
- const axutil_env_t *env,
- const axis2_char_t *action);
+ axis2_msg_info_headers_set_action(
+ struct axis2_msg_info_headers *msg_info_headers,
+ const axutil_env_t * env,
+ const axis2_char_t * action);
/**
* Gets message ID. message ID is an absolute IRI that uniquely
@@ -337,8 +372,10 @@
* @return message ID string.
*/
AXIS2_EXTERN const axis2_char_t *AXIS2_CALL
- axis2_msg_info_headers_get_message_id(const axis2_msg_info_headers_t *msg_info_headers,
- const axutil_env_t *env);
+
+ axis2_msg_info_headers_get_message_id(
+ const axis2_msg_info_headers_t * msg_info_headers,
+ const axutil_env_t * env);
/**
* Sets message ID. message ID is an absolute IRI that uniquely
@@ -349,9 +386,11 @@
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
- axis2_msg_info_headers_set_message_id(struct axis2_msg_info_headers *msg_info_headers,
- const axutil_env_t *env,
- const axis2_char_t *message_id);
+
+ axis2_msg_info_headers_set_message_id(
+ struct axis2_msg_info_headers *msg_info_headers,
+ const axutil_env_t * env,
+ const axis2_char_t * message_id);
/**
* Gets relates to information.
@@ -362,8 +401,10 @@
* @sa axis2_relates_to
*/
AXIS2_EXTERN axis2_relates_to_t *AXIS2_CALL
- axis2_msg_info_headers_get_relates_to(const axis2_msg_info_headers_t *msg_info_headers,
- const axutil_env_t *env);
+
+ axis2_msg_info_headers_get_relates_to(
+ const axis2_msg_info_headers_t * msg_info_headers,
+ const axutil_env_t * env);
/**
* Sets relates to information.
@@ -374,9 +415,11 @@
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
- axis2_msg_info_headers_set_relates_to(struct axis2_msg_info_headers *msg_info_headers,
- const axutil_env_t *env,
- axis2_relates_to_t *relates_to);
+
+ axis2_msg_info_headers_set_relates_to(
+ struct axis2_msg_info_headers *msg_info_headers,
+ const axutil_env_t * env,
+ axis2_relates_to_t * relates_to);
/**
* Gets all reference parameters associated with message information
@@ -386,8 +429,10 @@
* @return pointer to array list containing all reference parameters
*/
AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL
- axis2_msg_info_headers_get_all_ref_params(const axis2_msg_info_headers_t *msg_info_headers,
- const axutil_env_t *env);
+
+ axis2_msg_info_headers_get_all_ref_params(
+ const axis2_msg_info_headers_t * msg_info_headers,
+ const axutil_env_t * env);
/**
* Adds a reference parameter in the form of an AXIOM node.
@@ -399,9 +444,11 @@
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
- axis2_msg_info_headers_add_ref_param(struct axis2_msg_info_headers *msg_info_headers,
- const axutil_env_t *env,
- axiom_node_t *ref_param);
+
+ axis2_msg_info_headers_add_ref_param(
+ struct axis2_msg_info_headers *msg_info_headers,
+ const axutil_env_t * env,
+ axiom_node_t * ref_param);
/**
* Frees message information header struct.
@@ -410,13 +457,14 @@
* @return void
*/
AXIS2_EXTERN void AXIS2_CALL
- axis2_msg_info_headers_free(struct axis2_msg_info_headers *msg_info_headers,
- const axutil_env_t *env);
+ axis2_msg_info_headers_free(
+ struct axis2_msg_info_headers *msg_info_headers,
+ const axutil_env_t * env);
-/** @} */
+ /** @} */
#ifdef __cplusplus
}
#endif
-#endif /* AXIS2_MSG_INFO_HEADERS_H */
+#endif /* AXIS2_MSG_INFO_HEADERS_H */
Modified: webservices/axis2/trunk/c/include/axis2_msg_recv.h
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/c/include/axis2_msg_recv.h?rev=580274&r1=580273&r2=580274&view=diff
==============================================================================
--- webservices/axis2/trunk/c/include/axis2_msg_recv.h (original)
+++ webservices/axis2/trunk/c/include/axis2_msg_recv.h Fri Sep 28 02:47:09 2007
@@ -1,3 +1,4 @@
+
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
@@ -22,7 +23,7 @@
* @defgroup axis2_receivers receivers
* @ingroup axis2
* @{
- * @}
+ * @}
*/
/** @defgroup axis2_msg_recv message receiver
@@ -33,7 +34,7 @@
/**
* @file axis2_msg_recv.h
- * @brief Axis Message Receiver interface. Message Receiver struct.
+ * @brief Axis Message Receiver interface. Message Receiver struct.
* This interface is extended by custom message receivers
*/
@@ -50,6 +51,7 @@
#include <axis2_svr_callback.h>
struct axis2_msg_ctx;
+
/** Type name for struct axis2_msg_recv*/
typedef struct axis2_msg_recv axis2_msg_recv_t;
@@ -60,8 +62,9 @@
* @return void
*/
AXIS2_EXTERN void AXIS2_CALL
- axis2_msg_recv_free(axis2_msg_recv_t *msg_recv,
- const axutil_env_t *env);
+ axis2_msg_recv_free(
+ axis2_msg_recv_t * msg_recv,
+ const axutil_env_t * env);
/**
* This method is called from axis2_engine_receive method. This method's
@@ -77,8 +80,9 @@
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
- axis2_msg_recv_receive(axis2_msg_recv_t *msg_recv,
- const axutil_env_t *env,
+ axis2_msg_recv_receive(
+ axis2_msg_recv_t * msg_recv,
+ const axutil_env_t * env,
struct axis2_msg_ctx *in_msg_ctx,
void *callback_recv_param);
@@ -91,8 +95,10 @@
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
- axis2_msg_recv_invoke_business_logic(axis2_msg_recv_t *msg_recv,
- const axutil_env_t *env,
+
+ axis2_msg_recv_invoke_business_logic(
+ axis2_msg_recv_t * msg_recv,
+ const axutil_env_t * env,
struct axis2_msg_ctx *in_msg_ctx,
struct axis2_msg_ctx *out_msg_ctx);
@@ -104,8 +110,10 @@
* @return service skeleton object
*/
AXIS2_EXTERN axis2_svc_skeleton_t *AXIS2_CALL
- axis2_msg_recv_make_new_svc_obj(axis2_msg_recv_t *msg_recv,
- const axutil_env_t *env,
+
+ axis2_msg_recv_make_new_svc_obj(
+ axis2_msg_recv_t * msg_recv,
+ const axutil_env_t * env,
struct axis2_msg_ctx *msg_ctx);
/**
@@ -116,8 +124,10 @@
* @return service skeleton object
*/
AXIS2_EXTERN axis2_svc_skeleton_t *AXIS2_CALL
- axis2_msg_recv_get_impl_obj(axis2_msg_recv_t *msg_recv,
- const axutil_env_t *env,
+
+ axis2_msg_recv_get_impl_obj(
+ axis2_msg_recv_t * msg_recv,
+ const axutil_env_t * env,
struct axis2_msg_ctx *msg_ctx);
/**
@@ -128,10 +138,10 @@
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
- axis2_msg_recv_set_scope(axis2_msg_recv_t *msg_recv,
- const axutil_env_t *env,
- const axis2_char_t *scope);
-
+ axis2_msg_recv_set_scope(
+ axis2_msg_recv_t * msg_recv,
+ const axutil_env_t * env,
+ const axis2_char_t * scope);
/**
* Get the application scope
@@ -140,8 +150,9 @@
* @return scope
*/
AXIS2_EXTERN axis2_char_t *AXIS2_CALL
- axis2_msg_recv_get_scope(axis2_msg_recv_t *msg_recv,
- const axutil_env_t *env);
+ axis2_msg_recv_get_scope(
+ axis2_msg_recv_t * msg_recv,
+ const axutil_env_t * env);
/**
* Delete the service skeleton object created by make_new_svc_obj
@@ -151,28 +162,34 @@
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
- axis2_msg_recv_delete_svc_obj(axis2_msg_recv_t *msg_recv,
- const axutil_env_t *env,
- axis2_msg_ctx_t *msg_ctx);
+ axis2_msg_recv_delete_svc_obj(
+ axis2_msg_recv_t * msg_recv,
+ const axutil_env_t * env,
+ axis2_msg_ctx_t * msg_ctx);
AXIS2_EXPORT axis2_status_t AXIS2_CALL
- axis2_msg_recv_set_invoke_business_logic(axis2_msg_recv_t *msg_recv,
- const axutil_env_t *env,
+
+ axis2_msg_recv_set_invoke_business_logic(
+ axis2_msg_recv_t * msg_recv,
+ const axutil_env_t * env,
void *func);
AXIS2_EXPORT axis2_status_t AXIS2_CALL
- axis2_msg_recv_set_derived(axis2_msg_recv_t *msg_recv,
- const axutil_env_t *env,
+ axis2_msg_recv_set_derived(
+ axis2_msg_recv_t * msg_recv,
+ const axutil_env_t * env,
void *derived);
AXIS2_EXPORT void *AXIS2_CALL
- axis2_msg_recv_get_derived(const axis2_msg_recv_t *msg_recv,
- const axutil_env_t *env);
+ axis2_msg_recv_get_derived(
+ const axis2_msg_recv_t * msg_recv,
+ const axutil_env_t * env);
- AXIS2_EXPORT axis2_status_t AXIS2_CALL
- axis2_msg_recv_set_receive(axis2_msg_recv_t *msg_recv,
- const axutil_env_t *env,
- void *func);
+ AXIS2_EXPORT axis2_status_t AXIS2_CALL
+ axis2_msg_recv_set_receive(
+ axis2_msg_recv_t * msg_recv,
+ const axutil_env_t * env,
+ void *func);
/**
* Create new message receiver object. usually this will be called from the
@@ -182,12 +199,12 @@
* @return newly created message receiver object
**/
AXIS2_EXTERN axis2_msg_recv_t *AXIS2_CALL
- axis2_msg_recv_create (const axutil_env_t *env);
-
+ axis2_msg_recv_create(
+ const axutil_env_t * env);
-/** @} */
+ /** @} */
#ifdef __cplusplus
}
#endif
-#endif /* AXIS2_MSG_RECV_H */
+#endif /* AXIS2_MSG_RECV_H */
Modified: webservices/axis2/trunk/c/include/axis2_op.h
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/c/include/axis2_op.h?rev=580274&r1=580273&r2=580274&view=diff
==============================================================================
--- webservices/axis2/trunk/c/include/axis2_op.h (original)
+++ webservices/axis2/trunk/c/include/axis2_op.h Fri Sep 28 02:47:09 2007
@@ -1,3 +1,4 @@
+
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
@@ -18,20 +19,20 @@
#ifndef AXIS2_OP_H
#define AXIS2_OP_H
-/**
+/**
* @defgroup axis2_op operation
* @ingroup axis2_desc
- * operation represents the static structure of an operation in a service.
- * In Axis2 description hierarchy, an operation lives inside the service to
- * which it belongs.
- * operations are configured in services.xml files located in the respective
- * service group folders of the services folder in the repository.
- * In services.xml file, operations are declared in association with a given
- * service. The deployment engine would create operation instances to represent
- * those configured operations and would associate them with the respective
+ * operation represents the static structure of an operation in a service.
+ * In Axis2 description hierarchy, an operation lives inside the service to
+ * which it belongs.
+ * operations are configured in services.xml files located in the respective
+ * service group folders of the services folder in the repository.
+ * In services.xml file, operations are declared in association with a given
+ * service. The deployment engine would create operation instances to represent
+ * those configured operations and would associate them with the respective
* service in the configuration.
- * operation encapsulates data on message exchange pattern (MEP), the
- * execution flows, engaged module information, and the message receiver
+ * operation encapsulates data on message exchange pattern (MEP), the
+ * execution flows, engaged module information, and the message receiver
* associated with the operation.
* @{
*/
@@ -68,18 +69,17 @@
struct axis2_msg;
struct axis2_conf;
-/** SOAP action string constant */
+ /** SOAP action string constant */
#define AXIS2_SOAP_ACTION "soapAction"
-
/**
* Creates operation struct.
* @param env pointer to environment struct
* @return pointer to newly created operation
*/
AXIS2_EXTERN axis2_op_t *AXIS2_CALL
- axis2_op_create(const axutil_env_t *env);
-
+ axis2_op_create(
+ const axutil_env_t * env);
/**
* Frees operation.
@@ -88,8 +88,9 @@
* @return void
*/
AXIS2_EXTERN void AXIS2_CALL
- axis2_op_free(axis2_op_t *op,
- const axutil_env_t *env);
+ axis2_op_free(
+ axis2_op_t * op,
+ const axutil_env_t * env);
/**
* Frees operation given as a void pointer.
@@ -98,9 +99,9 @@
* @return void
*/
AXIS2_EXTERN void AXIS2_CALL
- axis2_op_free_void_arg(void *op,
- const axutil_env_t *env);
-
+ axis2_op_free_void_arg(
+ void *op,
+ const axutil_env_t * env);
/**
* Adds a parameter to method.
@@ -111,9 +112,10 @@
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
- axis2_op_add_param(axis2_op_t *op,
- const axutil_env_t *env,
- axutil_param_t *param);
+ axis2_op_add_param(
+ axis2_op_t * op,
+ const axutil_env_t * env,
+ axutil_param_t * param);
/**
* Gets named parameter.
@@ -124,9 +126,10 @@
* reference, not a cloned copy
*/
AXIS2_EXTERN axutil_param_t *AXIS2_CALL
- axis2_op_get_param(const axis2_op_t *op,
- const axutil_env_t *env,
- const axis2_char_t *name);
+ axis2_op_get_param(
+ const axis2_op_t * op,
+ const axutil_env_t * env,
+ const axis2_char_t * name);
/**
* Gets all parameters.
@@ -136,8 +139,9 @@
* a reference, not a cloned copy
*/
AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL
- axis2_op_get_all_params(const axis2_op_t *op,
- const axutil_env_t *env);
+ axis2_op_get_all_params(
+ const axis2_op_t * op,
+ const axutil_env_t * env);
/**
* Checks if the named parameter is locked.
@@ -147,9 +151,10 @@
* @return AXIS2_TRUE if named parameter is locked, else AXIS2_FALSE
*/
AXIS2_EXTERN axis2_bool_t AXIS2_CALL
- axis2_op_is_param_locked(axis2_op_t *op,
- const axutil_env_t *env,
- const axis2_char_t *param_name);
+ axis2_op_is_param_locked(
+ axis2_op_t * op,
+ const axutil_env_t * env,
+ const axis2_char_t * param_name);
/**
* Sets parent. Parent of an operation is of type service.
@@ -160,8 +165,9 @@
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
- axis2_op_set_parent(axis2_op_t *op,
- const axutil_env_t *env,
+ axis2_op_set_parent(
+ axis2_op_t * op,
+ const axutil_env_t * env,
struct axis2_svc *svc);
/**
@@ -172,8 +178,9 @@
* copy
*/
AXIS2_EXTERN struct axis2_svc *AXIS2_CALL
- axis2_op_get_parent(const axis2_op_t *op,
- const axutil_env_t *env);
+ axis2_op_get_parent(
+ const axis2_op_t * op,
+ const axutil_env_t * env);
/**
* Sets operation QName.
@@ -185,9 +192,10 @@
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
- axis2_op_set_qname(axis2_op_t *op,
- const axutil_env_t *env,
- const axutil_qname_t *qname);
+ axis2_op_set_qname(
+ axis2_op_t * op,
+ const axutil_env_t * env,
+ const axutil_qname_t * qname);
/**
* Gets operation QName.
@@ -196,8 +204,9 @@
* @return pointer to QName, returns a reference, not a cloned copy
*/
AXIS2_EXTERN const axutil_qname_t *AXIS2_CALL
- axis2_op_get_qname(void *op,
- const axutil_env_t *env);
+ axis2_op_get_qname(
+ void *op,
+ const axutil_env_t * env);
/**
* Sets operation message exchange pattern (MEP).
@@ -207,9 +216,10 @@
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
- axis2_op_set_msg_exchange_pattern(axis2_op_t *op,
- const axutil_env_t *env,
- const axis2_char_t *pattern);
+ axis2_op_set_msg_exchange_pattern(
+ axis2_op_t * op,
+ const axutil_env_t * env,
+ const axis2_char_t * pattern);
/**
* Gets operation message exchange pattern (MEP).
@@ -218,8 +228,10 @@
* @return MEP string
*/
AXIS2_EXTERN const axis2_char_t *AXIS2_CALL
- axis2_op_get_msg_exchange_pattern(const axis2_op_t *op,
- const axutil_env_t *env);
+
+ axis2_op_get_msg_exchange_pattern(
+ const axis2_op_t * op,
+ const axutil_env_t * env);
/**
* Sets message receiver. message receiver is responsible for invoking
@@ -231,8 +243,9 @@
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
- axis2_op_set_msg_recv(axis2_op_t *op,
- const axutil_env_t *env,
+ axis2_op_set_msg_recv(
+ axis2_op_t * op,
+ const axutil_env_t * env,
struct axis2_msg_recv *msg_recv);
/**
@@ -244,8 +257,9 @@
* cloned copy
*/
AXIS2_EXTERN struct axis2_msg_recv *AXIS2_CALL
- axis2_op_get_msg_recv(const axis2_op_t *op,
- const axutil_env_t *env);
+ axis2_op_get_msg_recv(
+ const axis2_op_t * op,
+ const axutil_env_t * env);
/**
* Gets style of operation. Style is that mentioned in WSDL, either
@@ -255,8 +269,9 @@
* @return string representing style
*/
AXIS2_EXTERN const axis2_char_t *AXIS2_CALL
- axis2_op_get_style(const axis2_op_t *op,
- const axutil_env_t *env);
+ axis2_op_get_style(
+ const axis2_op_t * op,
+ const axutil_env_t * env);
/**
* Sets style of operation. Style is that mentioned in WSDL, either
@@ -267,9 +282,10 @@
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
- axis2_op_set_style(axis2_op_t *op,
- const axutil_env_t *env,
- const axis2_char_t *style);
+ axis2_op_set_style(
+ axis2_op_t * op,
+ const axutil_env_t * env,
+ const axis2_char_t * style);
/**
* Engages given module to operation.
@@ -282,8 +298,9 @@
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
- axis2_op_engage_module(axis2_op_t *op,
- const axutil_env_t *env,
+ axis2_op_engage_module(
+ axis2_op_t * op,
+ const axutil_env_t * env,
struct axis2_module_desc *module_desc,
struct axis2_conf *conf);
@@ -296,8 +313,10 @@
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
- axis2_op_add_to_engaged_module_list(axis2_op_t *op,
- const axutil_env_t *env,
+
+ axis2_op_add_to_engaged_module_list(
+ axis2_op_t * op,
+ const axutil_env_t * env,
struct axis2_module_desc *module_dec);
/**
@@ -307,8 +326,9 @@
* @return pointer to array list containing module descriptions
*/
AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL
- axis2_op_get_all_modules(const axis2_op_t *op,
- const axutil_env_t *env);
+ axis2_op_get_all_modules(
+ const axis2_op_t * op,
+ const axutil_env_t * env);
/**
* Gets Axis specific MEP constant. This method simply maps the string
@@ -318,8 +338,9 @@
* @return integer representing MEP
*/
AXIS2_EXTERN int AXIS2_CALL
- axis2_op_get_axis_specific_mep_const(axis2_op_t *op,
- const axutil_env_t *env);
+ axis2_op_get_axis_specific_mep_const(
+ axis2_op_t * op,
+ const axutil_env_t * env);
/**
* Gets fault in flow. Fault in flow is the list of phases invoked
@@ -330,33 +351,35 @@
* not a cloned copy
*/
AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL
- axis2_op_get_fault_in_flow(const axis2_op_t *op,
- const axutil_env_t *env);
-
+ axis2_op_get_fault_in_flow(
+ const axis2_op_t * op,
+ const axutil_env_t * env);
/**
* Gets fault out flow. Fault out flow is the list of phases invoked
- * when a fault happens along out path.
+ * when a fault happens along out path.
* @param op pointer to operation
* @param env pointer to environment struct
* @return pointer to array list containing phases, returns a reference,
* not a cloned copy
*/
AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL
- axis2_op_get_fault_out_flow(const axis2_op_t *op,
- const axutil_env_t *env);
+ axis2_op_get_fault_out_flow(
+ const axis2_op_t * op,
+ const axutil_env_t * env);
/**
* Gets out flow. Out flow is the list of phases invoked
- * along out path.
+ * along out path.
* @param op pointer to operation
* @param env pointer to environment struct
* @return pointer to array list containing phases, returns a reference,
- * not a cloned copy
+ * not a cloned copy
*/
AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL
- axis2_op_get_out_flow(const axis2_op_t *op,
- const axutil_env_t *env);
+ axis2_op_get_out_flow(
+ const axis2_op_t * op,
+ const axutil_env_t * env);
/**
* Gets in flow. In flow is the list of phases
@@ -367,26 +390,28 @@
* not a cloned copy
*/
AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL
- axis2_op_get_in_flow(const axis2_op_t *op,
- const axutil_env_t *env);
+ axis2_op_get_in_flow(
+ const axis2_op_t * op,
+ const axutil_env_t * env);
/**
* Sets fault in flow. Fault in flow is the list of phases invoked
- * when a fault happens along in path.
+ * when a fault happens along in path.
* @param op pointer to operation
* @param env pointer to environment struct
* @param list pointer to array list containing phases, operation takes
- * over the ownership of list
+ * over the ownership of list
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
- axis2_op_set_fault_in_flow(axis2_op_t *op,
- const axutil_env_t *env,
- axutil_array_list_t *list);
+ axis2_op_set_fault_in_flow(
+ axis2_op_t * op,
+ const axutil_env_t * env,
+ axutil_array_list_t * list);
/**
* Sets fault out flow. Fault out flow is the list of phases invoked
- * when a fault happens along out path.
+ * when a fault happens along out path.
* @param op pointer to operation
* @param env pointer to environment struct
* @param list pointer to array list containing phases, operation takes
@@ -394,13 +419,14 @@
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
- axis2_op_set_fault_out_flow(axis2_op_t *op,
- const axutil_env_t *env,
- axutil_array_list_t *list);
+ axis2_op_set_fault_out_flow(
+ axis2_op_t * op,
+ const axutil_env_t * env,
+ axutil_array_list_t * list);
/**
* Sets out flow. Out flow is the list of phases invoked
- * along out path.
+ * along out path.
* @param op pointer to operation
* @param env pointer to environment struct
* @param list pointer to array list containing phases, operation takes
@@ -408,9 +434,10 @@
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
- axis2_op_set_out_flow(axis2_op_t *op,
- const axutil_env_t *env,
- axutil_array_list_t *list);
+ axis2_op_set_out_flow(
+ axis2_op_t * op,
+ const axutil_env_t * env,
+ axutil_array_list_t * list);
/**
* Sets in flow. In flow is the list of phases
@@ -422,9 +449,10 @@
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
- axis2_op_set_in_flow(axis2_op_t *op,
- const axutil_env_t *env,
- axutil_array_list_t *list);
+ axis2_op_set_in_flow(
+ axis2_op_t * op,
+ const axutil_env_t * env,
+ axutil_array_list_t * list);
/**
* Adds given QName to module QName list.
@@ -435,9 +463,10 @@
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
- axis2_op_add_module_qname(axis2_op_t *op,
- const axutil_env_t *env,
- const axutil_qname_t *module_qname);
+ axis2_op_add_module_qname(
+ axis2_op_t * op,
+ const axutil_env_t * env,
+ const axutil_qname_t * module_qname);
/**
* Gets all module QNames as a list.
@@ -447,8 +476,10 @@
* returns a reference, not a cloned copy
*/
AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL
- axis2_op_get_all_module_qnames(const axis2_op_t *op,
- const axutil_env_t *env);
+
+ axis2_op_get_all_module_qnames(
+ const axis2_op_t * op,
+ const axutil_env_t * env);
/**
* Finds operation context related to this operation using given message
@@ -462,10 +493,11 @@
* a reference, not a cloned copy
*/
AXIS2_EXTERN struct axis2_op_ctx *AXIS2_CALL
- axis2_op_find_op_ctx(axis2_op_t *op,
- const axutil_env_t *env,
- struct axis2_msg_ctx *msg_ctx,
- struct axis2_svc_ctx *svc_ctx);
+ axis2_op_find_op_ctx(
+ axis2_op_t * op,
+ const axutil_env_t * env,
+ struct axis2_msg_ctx *msg_ctx,
+ struct axis2_svc_ctx *svc_ctx);
/**
* Finds operation context related to this operation using given message
@@ -479,9 +511,11 @@
*/
AXIS2_EXTERN struct axis2_op_ctx *AXIS2_CALL
- axis2_op_find_existing_op_ctx(axis2_op_t *op,
- const axutil_env_t *env,
- const struct axis2_msg_ctx *msg_ctx);
+
+ axis2_op_find_existing_op_ctx(
+ axis2_op_t * op,
+ const axutil_env_t * env,
+ const struct axis2_msg_ctx *msg_ctx);
/**
* Registers given operation context against this operation. Registration
@@ -495,8 +529,9 @@
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
- axis2_op_register_op_ctx(axis2_op_t *op,
- const axutil_env_t *env,
+ axis2_op_register_op_ctx(
+ axis2_op_t * op,
+ const axutil_env_t * env,
struct axis2_msg_ctx *msg_ctx,
struct axis2_op_ctx *op_ctx);
@@ -508,9 +543,10 @@
* a reference, not a cloned copy
*/
AXIS2_EXTERN struct axis2_msg *AXIS2_CALL
- axis2_op_get_msg(const axis2_op_t *op,
- const axutil_env_t *env,
- const axis2_char_t *label);
+ axis2_op_get_msg(
+ const axis2_op_t * op,
+ const axutil_env_t * env,
+ const axis2_char_t * label);
/**
* Adds given message with the given label.
@@ -521,9 +557,10 @@
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
- axis2_op_add_msg(axis2_op_t *op,
- const axutil_env_t *env,
- const axis2_char_t *label,
+ axis2_op_add_msg(
+ axis2_op_t * op,
+ const axutil_env_t * env,
+ const axis2_char_t * label,
const struct axis2_msg *msg);
/**
@@ -533,8 +570,9 @@
* AXIS2_TRUE if the operation is from a module, else AXIS2_FALSE
*/
AXIS2_EXTERN axis2_bool_t AXIS2_CALL
- axis2_op_is_from_module(const axis2_op_t *op,
- const axutil_env_t *env);
+ axis2_op_is_from_module(
+ const axis2_op_t * op,
+ const axutil_env_t * env);
/**
* Set the wsamapping list.
@@ -544,9 +582,10 @@
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
- axis2_op_set_wsamapping_list(axis2_op_t *op,
- const axutil_env_t *env,
- axutil_array_list_t *mapping_list);
+ axis2_op_set_wsamapping_list(
+ axis2_op_t * op,
+ const axutil_env_t * env,
+ axutil_array_list_t * mapping_list);
/**
* Get the wsamapping list.
@@ -555,16 +594,22 @@
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL
- axis2_op_get_wsamapping_list(axis2_op_t *op,
- const axutil_env_t *env);
+
+ axis2_op_get_wsamapping_list(
+ axis2_op_t * op,
+ const axutil_env_t * env);
AXIS2_EXTERN axutil_param_container_t *AXIS2_CALL
- axis2_op_get_param_container(const axis2_op_t *op,
- const axutil_env_t *env);
+
+ axis2_op_get_param_container(
+ const axis2_op_t * op,
+ const axutil_env_t * env);
AXIS2_EXTERN axis2_status_t AXIS2_CALL
- axis2_op_remove_from_engaged_module_list(axis2_op_t *op,
- const axutil_env_t *env,
+
+ axis2_op_remove_from_engaged_module_list(
+ axis2_op_t * op,
+ const axutil_env_t * env,
struct axis2_module_desc *module_desc);
/**
@@ -573,7 +618,8 @@
* @return pointer to newly created operation
*/
AXIS2_EXTERN axis2_op_t *AXIS2_CALL
- axis2_op_create_from_module(const axutil_env_t *env);
+ axis2_op_create_from_module(
+ const axutil_env_t * env);
/**
* Creates operation struct with given QName.
@@ -582,8 +628,9 @@
* @return pointer to newly created operation
*/
AXIS2_EXTERN axis2_op_t *AXIS2_CALL
- axis2_op_create_with_qname(const axutil_env_t *env,
- const axutil_qname_t *name);
+ axis2_op_create_with_qname(
+ const axutil_env_t * env,
+ const axutil_qname_t * name);
/**
* Frees the operation given as a void pointer. This method would cast the
@@ -593,20 +640,23 @@
* @return void
*/
AXIS2_EXTERN void AXIS2_CALL
- axis2_op_free_void_arg(void *op,
- const axutil_env_t *env);
+ axis2_op_free_void_arg(
+ void *op,
+ const axutil_env_t * env);
- /**
+ /**
* Gets base description.
* @param op pointer to message
* @param env pointer to environment struct
* @return pointer to base description struct
*/
AXIS2_EXTERN axis2_desc_t *AXIS2_CALL
- axis2_op_get_base(const axis2_op_t *op,
- const axutil_env_t *env);
-/** @} */
+ axis2_op_get_base(
+ const axis2_op_t * op,
+ const axutil_env_t * env);
+
+ /** @} */
#ifdef __cplusplus
}
#endif
-#endif /* AXIS2_OP_H */
+#endif /* AXIS2_OP_H */
Modified: webservices/axis2/trunk/c/include/axis2_op_client.h
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/c/include/axis2_op_client.h?rev=580274&r1=580273&r2=580274&view=diff
==============================================================================
--- webservices/axis2/trunk/c/include/axis2_op_client.h (original)
+++ webservices/axis2/trunk/c/include/axis2_op_client.h Fri Sep 28 02:47:09 2007
@@ -1,3 +1,4 @@
+
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
@@ -29,20 +30,19 @@
* @defgroup axis2_op_client operation client
* @ingroup axis2_client_api
* The operation client is meant to be used by advanced users to consume services.
- * Operation client understands a specific Message Exchange Pattern (op) and
- * hence the behavior is defined by the op.
- * To consume services with an operation client, an operation (of type axis2_op_t)
+ * Operation client understands a specific Message Exchange Pattern (op) and
+ * hence the behavior is defined by the op.
+ * To consume services with an operation client, an operation (of type axis2_op_t)
* and a service context (of type axis2_svc_ctx_t)
* has to be provided along with options to be used. The execute() function
- * can be used to send the request and get the response.
+ * can be used to send the request and get the response.
* The service client implementation uses the operation client and provides an
- * easy to use API for consuming services. Hence the service client
+ * easy to use API for consuming services. Hence the service client
* implementation is a very good example of how to use the operation client API.
* @sa axis2_svc_client
* @{
*/
-
/**
* @file axis2_op_client.h
*/
@@ -60,9 +60,8 @@
/** Type name for struct axis2_op_client */
typedef struct axis2_op_client axis2_op_client_t;
-
- struct axis2_callback_recv;
+ struct axis2_callback_recv;
/**
* Sets the options that is to be used by this operation client.
@@ -72,20 +71,23 @@
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
- axis2_op_client_set_options(axis2_op_client_t *op_client,
- const axutil_env_t *env,
- const axis2_options_t *options);
+ axis2_op_client_set_options(
+ axis2_op_client_t * op_client,
+ const axutil_env_t * env,
+ const axis2_options_t * options);
/**
* Gets options used by operation client.
* @param op_client pointer to operation client struct
* @param env pointer to environment struct
* @return a pointer to the options struct if options set, else NULL.
- * Returns a reference, not a cloned copy.
+ * Returns a reference, not a cloned copy.
*/
- AXIS2_EXTERN const axis2_options_t* AXIS2_CALL
- axis2_op_client_get_options(const axis2_op_client_t *op_client,
- const axutil_env_t *env);
+ AXIS2_EXTERN const axis2_options_t *AXIS2_CALL
+
+ axis2_op_client_get_options(
+ const axis2_op_client_t * op_client,
+ const axutil_env_t * env);
/**
* Adds a message context to the client for processing.
@@ -97,9 +99,9 @@
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_op_client_add_msg_ctx(
- axis2_op_client_t *op_client,
- const axutil_env_t *env,
- axis2_msg_ctx_t *msg_ctx);
+ axis2_op_client_t * op_client,
+ const axutil_env_t * env,
+ axis2_msg_ctx_t * msg_ctx);
/**
* Adds out message context to the client for processing.
@@ -110,10 +112,10 @@
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
- axis2_op_client_add_out_msg_ctx(axis2_op_client_t *op_client,
- const axutil_env_t *env,
- axis2_msg_ctx_t *msg_ctx);
-
+ axis2_op_client_add_out_msg_ctx(
+ axis2_op_client_t * op_client,
+ const axutil_env_t * env,
+ axis2_msg_ctx_t * msg_ctx);
/**
* Gets a message corresponding to the given label.
@@ -123,9 +125,11 @@
* @return the desired message context or NULL if its not available.
* Returns a reference, not a cloned copy.
*/
- AXIS2_EXTERN const axis2_msg_ctx_t* AXIS2_CALL
- axis2_op_client_get_msg_ctx(const axis2_op_client_t *op_client,
- const axutil_env_t *env,
+ AXIS2_EXTERN const axis2_msg_ctx_t *AXIS2_CALL
+
+ axis2_op_client_get_msg_ctx(
+ const axis2_op_client_t * op_client,
+ const axutil_env_t * env,
const axis2_wsdl_msg_labels_t message_label);
/**
@@ -137,9 +141,11 @@
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
- axis2_op_client_set_callback(axis2_op_client_t *op_client,
- const axutil_env_t *env,
- axis2_callback_t *callback);
+ axis2_op_client_set_callback(
+ axis2_op_client_t * op_client,
+ const axutil_env_t * env,
+ axis2_callback_t * callback);
+
/**
* Gets the callback.
* @param op_client pointer to operation client struct
@@ -147,8 +153,9 @@
* @return callback
*/
AXIS2_EXTERN axis2_callback_t *AXIS2_CALL
- axis2_op_client_get_callback(axis2_op_client_t *op_client,
- const axutil_env_t *env);
+ axis2_op_client_get_callback(
+ axis2_op_client_t * op_client,
+ const axutil_env_t * env);
/**
* Execute the op. What this does depends on the specific operation client.
@@ -162,8 +169,9 @@
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
- axis2_op_client_execute(axis2_op_client_t *op_client,
- const axutil_env_t *env,
+ axis2_op_client_execute(
+ axis2_op_client_t * op_client,
+ const axutil_env_t * env,
const axis2_bool_t block);
/**
@@ -175,8 +183,9 @@
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
- axis2_op_client_reset(axis2_op_client_t *op_client,
- const axutil_env_t *env);
+ axis2_op_client_reset(
+ axis2_op_client_t * op_client,
+ const axutil_env_t * env);
/**
* Completes the execution by closing the transports if necessary.
@@ -188,19 +197,21 @@
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
- axis2_op_client_complete(axis2_op_client_t *op_client,
- const axutil_env_t *env,
- axis2_msg_ctx_t *msg_ctx);
+ axis2_op_client_complete(
+ axis2_op_client_t * op_client,
+ const axutil_env_t * env,
+ axis2_msg_ctx_t * msg_ctx);
/**
* Gets the operation context of the operation client.
* @param op_client pointer to operation client struct
- * @param env pointer to environment struct
+ * @param env pointer to environment struct
* @return operation context related to operation client
*/
- AXIS2_EXTERN axis2_op_ctx_t* AXIS2_CALL
- axis2_op_client_get_operation_context(const axis2_op_client_t *op_client,
- const axutil_env_t *env);
+ AXIS2_EXTERN axis2_op_ctx_t *AXIS2_CALL
+ axis2_op_client_get_operation_context(
+ const axis2_op_client_t * op_client,
+ const axutil_env_t * env);
/**
* Sets callback receiver.
@@ -211,8 +222,9 @@
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
- axis2_op_client_set_callback_recv(axis2_op_client_t *op_client,
- const axutil_env_t *env,
+ axis2_op_client_set_callback_recv(
+ axis2_op_client_t * op_client,
+ const axutil_env_t * env,
struct axis2_callback_recv *callback_recv);
/**
@@ -222,8 +234,9 @@
* @return void
*/
AXIS2_EXTERN void AXIS2_CALL
- axis2_op_client_free(axis2_op_client_t *op_client,
- const axutil_env_t *env);
+ axis2_op_client_free(
+ axis2_op_client_t * op_client,
+ const axutil_env_t * env);
/**
* Creates an operation client struct for the specified operation, service
@@ -240,13 +253,13 @@
* @return a pointer to newly created operation client struct,
* or NULL on error with error code set in environment's error
*/
- AXIS2_EXTERN axis2_op_client_t* AXIS2_CALL
- axis2_op_client_create(const axutil_env_t *env,
- axis2_op_t *op,
- axis2_svc_ctx_t *svc_ctx,
- axis2_options_t *options);
+ AXIS2_EXTERN axis2_op_client_t *AXIS2_CALL
+ axis2_op_client_create(
+ const axutil_env_t * env,
+ axis2_op_t * op,
+ axis2_svc_ctx_t * svc_ctx,
+ axis2_options_t * options);
-
/**
* Gets SOAP action.
* @param op_client pointer to op client struct
@@ -254,9 +267,10 @@
* @return a pointer to SOAP action string
*/
AXIS2_EXTERN axutil_string_t *AXIS2_CALL
- axis2_op_client_get_soap_action(const axis2_op_client_t *op_client,
- const axutil_env_t *env);
-
+ axis2_op_client_get_soap_action(
+ const axis2_op_client_t * op_client,
+ const axutil_env_t * env);
+
/**
* Prepares the message context for invocation. Here the properties kept
* in the op_client are copied to the message context.
@@ -267,10 +281,12 @@
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
- axis2_op_client_prepare_invocation(axis2_op_client_t *op_client,
- const axutil_env_t *env,
- axis2_op_t *op,
- axis2_msg_ctx_t *msg_ctx);
+
+ axis2_op_client_prepare_invocation(
+ axis2_op_client_t * op_client,
+ const axutil_env_t * env,
+ axis2_op_t * op,
+ axis2_msg_ctx_t * msg_ctx);
/**
* Prepares the SOAP envelope using the payload.
@@ -280,10 +296,12 @@
* @return a pointer to message context struct filled with the SOAP
* envelope to be sent
*/
- AXIS2_EXTERN axis2_msg_ctx_t* AXIS2_CALL
- axis2_op_client_prepare_soap_envelope(axis2_op_client_t *op_client,
- const axutil_env_t *env,
- axiom_node_t *to_send);
+ AXIS2_EXTERN axis2_msg_ctx_t *AXIS2_CALL
+
+ axis2_op_client_prepare_soap_envelope(
+ axis2_op_client_t * op_client,
+ const axutil_env_t * env,
+ axiom_node_t * to_send);
/**
* Tries to infer the transport looking at the URL, the URL can be http://
@@ -295,9 +313,11 @@
* @return pointer to the transport description with inferred information
*/
AXIS2_EXTERN axis2_transport_out_desc_t *AXIS2_CALL
- axis2_op_client_infer_transport(axis2_op_client_t *op_client,
- const axutil_env_t *env,
- axis2_endpoint_ref_t *epr);
+
+ axis2_op_client_infer_transport(
+ axis2_op_client_t * op_client,
+ const axutil_env_t * env,
+ axis2_endpoint_ref_t * epr);
/**
* Creates default SOAP envelope.
@@ -306,8 +326,10 @@
* @return pointer to default SOAP envelope created
*/
AXIS2_EXTERN axiom_soap_envelope_t *AXIS2_CALL
- axis2_op_client_create_default_soap_envelope(axis2_op_client_t *op_client,
- const axutil_env_t *env);
+
+ axis2_op_client_create_default_soap_envelope(
+ axis2_op_client_t * op_client,
+ const axutil_env_t * env);
/**
* Engage named module. The named module must have been configured in
@@ -320,10 +342,11 @@
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
- axis2_op_client_engage_module(axis2_op_client_t *op_client,
- const axutil_env_t *env,
- const axutil_qname_t *qname);
-
+ axis2_op_client_engage_module(
+ axis2_op_client_t * op_client,
+ const axutil_env_t * env,
+ const axutil_qname_t * qname);
+
/**
* Sets SOAP version URI.
* @param op_client pointer to op client struct
@@ -332,10 +355,12 @@
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
- axis2_op_client_set_soap_version_uri(axis2_op_client_t *op_client,
- const axutil_env_t *env,
- const axis2_char_t *soap_version_uri);
-
+
+ axis2_op_client_set_soap_version_uri(
+ axis2_op_client_t * op_client,
+ const axutil_env_t * env,
+ const axis2_char_t * soap_version_uri);
+
/**
* Sets SOAP action.
* @param op_client pointer to op client struct
@@ -344,10 +369,11 @@
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
- axis2_op_client_set_soap_action(axis2_op_client_t *op_client,
- const axutil_env_t *env,
- axutil_string_t *soap_action);
-
+ axis2_op_client_set_soap_action(
+ axis2_op_client_t * op_client,
+ const axutil_env_t * env,
+ axutil_string_t * soap_action);
+
/**
* Sets WSA action.
* @param op_client pointer to op client struct
@@ -356,24 +382,26 @@
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
- axis2_op_client_set_wsa_action(axis2_op_client_t *op_client,
- const axutil_env_t *env,
- const axis2_char_t *wsa_action);
+ axis2_op_client_set_wsa_action(
+ axis2_op_client_t * op_client,
+ const axutil_env_t * env,
+ const axis2_char_t * wsa_action);
/**
* Gets service context.
* @param op_client pointer to op client struct
- * @param env pointer to environment struct
+ * @param env pointer to environment struct
* @return pointer to service context struct if set, else NULL
*/
AXIS2_EXTERN axis2_svc_ctx_t *AXIS2_CALL
- axis2_op_client_get_svc_ctx(const axis2_op_client_t *op_client,
- const axutil_env_t *env);
+ axis2_op_client_get_svc_ctx(
+ const axis2_op_client_t * op_client,
+ const axutil_env_t * env);
AXIS2_EXTERN void AXIS2_CALL
axis2_op_client_set_reuse(
- axis2_op_client_t *op_client,
- const axutil_env_t *env,
+ axis2_op_client_t * op_client,
+ const axutil_env_t * env,
axis2_bool_t reuse);
/**
@@ -383,10 +411,11 @@
* @param msg_ctx pointer to message context representing the message to
* be sent
* @return message context representing the received response
- */
+ */
AXIS2_EXTERN axis2_msg_ctx_t *AXIS2_CALL
- axis2_op_client_two_way_send(const axutil_env_t *env,
- axis2_msg_ctx_t *msg_ctx);
+ axis2_op_client_two_way_send(
+ const axutil_env_t * env,
+ axis2_msg_ctx_t * msg_ctx);
/**
* Receives a message corresponding to a request depicted by given
@@ -397,11 +426,11 @@
* @return message context representing the received response
*/
AXIS2_EXTERN axis2_msg_ctx_t *AXIS2_CALL
- axis2_op_client_receive(const axutil_env_t *env,
- axis2_msg_ctx_t *msg_ctx);
-
+ axis2_op_client_receive(
+ const axutil_env_t * env,
+ axis2_msg_ctx_t * msg_ctx);
-/** @} */
+ /** @} */
#ifdef __cplusplus
}
#endif
Modified: webservices/axis2/trunk/c/include/axis2_op_ctx.h
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/c/include/axis2_op_ctx.h?rev=580274&r1=580273&r2=580274&view=diff
==============================================================================
--- webservices/axis2/trunk/c/include/axis2_op_ctx.h (original)
+++ webservices/axis2/trunk/c/include/axis2_op_ctx.h Fri Sep 28 02:47:09 2007
@@ -1,3 +1,4 @@
+
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
@@ -19,15 +20,15 @@
#define AXIS2_OP_CTX_H
/**
- * @defgroup axis2_op_ctx operation context
+ * @defgroup axis2_op_ctx operation context
* @ingroup axis2_context
* operation context represents a running "instance" of an operation.
- * operation context allows messages to be grouped into operations as in
- * WSDL 2.0 specification. operations are essentially arbitrary message exchange
- * patterns (MEP). So as messages are being exchanged, operation context remembers
+ * operation context allows messages to be grouped into operations as in
+ * WSDL 2.0 specification. operations are essentially arbitrary message exchange
+ * patterns (MEP). So as messages are being exchanged, operation context remembers
* the state of message exchange pattern specifics.
- * The implementation of operation context supports MEPs which have one input
- * message and/or one output message. In order to support other MEPs one must
+ * The implementation of operation context supports MEPs which have one input
+ * message and/or one output message. In order to support other MEPs one must
* extend this struct.
* @{
*/
@@ -49,7 +50,7 @@
/** Type name for struct axis2_op_ctx */
typedef struct axis2_op_ctx axis2_op_ctx_t;
-
+
struct axis2_svc_ctx;
/**
@@ -61,29 +62,32 @@
* @return pointer to newly created operation context
*/
AXIS2_EXTERN axis2_op_ctx_t *AXIS2_CALL
- axis2_op_ctx_create(const axutil_env_t *env,
- struct axis2_op *op,
- struct axis2_svc_ctx *svc_ctx);
-
- /**
- * Gets base which is of context type.
- * @param op_ctx pointer to operation context
- * @param env pointer to environment struct
- * @return pointer to base context
- */
+ axis2_op_ctx_create(
+ const axutil_env_t * env,
+ struct axis2_op *op,
+ struct axis2_svc_ctx *svc_ctx);
+
+ /**
+ * Gets base which is of context type.
+ * @param op_ctx pointer to operation context
+ * @param env pointer to environment struct
+ * @return pointer to base context
+ */
AXIS2_EXTERN axis2_ctx_t *AXIS2_CALL
- axis2_op_ctx_get_base(const axis2_op_ctx_t *op_ctx,
- const axutil_env_t *env);
+ axis2_op_ctx_get_base(
+ const axis2_op_ctx_t * op_ctx,
+ const axutil_env_t * env);
- /**
- * Frees operation context.
- * @param op_ctx pointer to operation context
- * @param env pointer to environment struct
- * @return void
- */
+ /**
+ * Frees operation context.
+ * @param op_ctx pointer to operation context
+ * @param env pointer to environment struct
+ * @return void
+ */
AXIS2_EXTERN void AXIS2_CALL
- axis2_op_ctx_free(struct axis2_op_ctx *op_ctx,
- const axutil_env_t *env);
+ axis2_op_ctx_free(
+ struct axis2_op_ctx *op_ctx,
+ const axutil_env_t * env);
/**
* Initializes operation context. This method traverses through all the
@@ -94,8 +98,9 @@
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
- axis2_op_ctx_init(struct axis2_op_ctx *op_ctx,
- const axutil_env_t *env,
+ axis2_op_ctx_init(
+ struct axis2_op_ctx *op_ctx,
+ const axutil_env_t * env,
struct axis2_conf *conf);
/**
@@ -105,8 +110,9 @@
* @return pointer to operation
*/
AXIS2_EXTERN struct axis2_op *AXIS2_CALL
- axis2_op_ctx_get_op(const axis2_op_ctx_t *op_ctx,
- const axutil_env_t *env);
+ axis2_op_ctx_get_op(
+ const axis2_op_ctx_t * op_ctx,
+ const axutil_env_t * env);
/**
* Gets parent which is of service context type.
@@ -116,8 +122,9 @@
* context lives
*/
AXIS2_EXTERN struct axis2_svc_ctx *AXIS2_CALL
- axis2_op_ctx_get_parent(const axis2_op_ctx_t *op_ctx,
- const axutil_env_t *env);
+ axis2_op_ctx_get_parent(
+ const axis2_op_ctx_t * op_ctx,
+ const axutil_env_t * env);
/**
* Adds a message context.
@@ -128,9 +135,10 @@
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
- axis2_op_ctx_add_msg_ctx(struct axis2_op_ctx *op_ctx,
- const axutil_env_t *env,
- axis2_msg_ctx_t *msg_ctx);
+ axis2_op_ctx_add_msg_ctx(
+ struct axis2_op_ctx *op_ctx,
+ const axutil_env_t * env,
+ axis2_msg_ctx_t * msg_ctx);
/**
* Gets message context with the given message ID.
@@ -140,8 +148,9 @@
* @return pointer to message context with given ID
*/
AXIS2_EXTERN axis2_msg_ctx_t *AXIS2_CALL
- axis2_op_ctx_get_msg_ctx(const axis2_op_ctx_t *op_ctx,
- const axutil_env_t *env,
+ axis2_op_ctx_get_msg_ctx(
+ const axis2_op_ctx_t * op_ctx,
+ const axutil_env_t * env,
const axis2_wsdl_msg_labels_t message_id);
/**
@@ -153,8 +162,9 @@
* @return AXIS2_TRUE if MEP invocation is complete, else AXIS2_FALSE
*/
AXIS2_EXTERN axis2_bool_t AXIS2_CALL
- axis2_op_ctx_get_is_complete(const axis2_op_ctx_t *op_ctx,
- const axutil_env_t *env);
+ axis2_op_ctx_get_is_complete(
+ const axis2_op_ctx_t * op_ctx,
+ const axutil_env_t * env);
/**
* Sets the bool value indicating if the MEP is complete.
@@ -167,8 +177,9 @@
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
- axis2_op_ctx_set_complete(struct axis2_op_ctx *op_ctx,
- const axutil_env_t *env,
+ axis2_op_ctx_set_complete(
+ struct axis2_op_ctx *op_ctx,
+ const axutil_env_t * env,
axis2_bool_t is_complete);
/**
@@ -179,8 +190,9 @@
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
- axis2_op_ctx_cleanup(struct axis2_op_ctx *op_ctx,
- const axutil_env_t *env);
+ axis2_op_ctx_cleanup(
+ struct axis2_op_ctx *op_ctx,
+ const axutil_env_t * env);
/**
* Sets parent service context.
@@ -191,8 +203,9 @@
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
- axis2_op_ctx_set_parent(struct axis2_op_ctx *op_ctx,
- const axutil_env_t *env,
+ axis2_op_ctx_set_parent(
+ struct axis2_op_ctx *op_ctx,
+ const axutil_env_t * env,
struct axis2_svc_ctx *svc_ctx);
/**
@@ -202,8 +215,9 @@
* @return pointer to hash table containing message contexts
*/
AXIS2_EXTERN axis2_msg_ctx_t **AXIS2_CALL
- axis2_op_ctx_get_msg_ctx_map(const axis2_op_ctx_t *op_ctx,
- const axutil_env_t *env);
+ axis2_op_ctx_get_msg_ctx_map(
+ const axis2_op_ctx_t * op_ctx,
+ const axutil_env_t * env);
/**
* Sets the bool value indicating the status of response.
@@ -214,25 +228,26 @@
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
- axis2_op_ctx_set_response_written(axis2_op_ctx_t *op_ctx,
- const axutil_env_t *env,
+ axis2_op_ctx_set_response_written(
+ axis2_op_ctx_t * op_ctx,
+ const axutil_env_t * env,
const axis2_bool_t response_written);
-
/**
* Checks the response status, whether it is written or not.
* @param msg_ctx message context
* @param env pointer to environment struct
- * @return AXIS2_TRUE if response is already written, else AXIS2_FALSE
+ * @return AXIS2_TRUE if response is already written, else AXIS2_FALSE
*/
AXIS2_EXTERN axis2_bool_t AXIS2_CALL
- axis2_op_ctx_get_response_written(const axis2_op_ctx_t *op_ctx,
- const axutil_env_t *env);
+ axis2_op_ctx_get_response_written(
+ const axis2_op_ctx_t * op_ctx,
+ const axutil_env_t * env);
AXIS2_EXTERN void AXIS2_CALL
axis2_op_ctx_destroy_mutex(
struct axis2_op_ctx *op_ctx,
- const axutil_env_t *env);
+ const axutil_env_t * env);
/**
* Checks whether op_ctx is in use. This is necessary when destroying the
@@ -240,12 +255,12 @@
* is still in use
* @param msg_ctx message context
* @param env pointer to environment struct
- * @return AXIS2_TRUE if still in use, else AXIS2_FALSE
+ * @return AXIS2_TRUE if still in use, else AXIS2_FALSE
*/
AXIS2_EXTERN axis2_bool_t AXIS2_CALL
axis2_op_ctx_is_in_use(
- const axis2_op_ctx_t *op_ctx,
- const axutil_env_t *env);
+ const axis2_op_ctx_t * op_ctx,
+ const axutil_env_t * env);
/**
* Set operation context's is_in_use attribute. This is necessary when
@@ -253,14 +268,13 @@
* operation context is still in use
* @param msg_ctx message context
* @param env pointer to environment struct
- * @return AXIS2_TRUE if still in use, else AXIS2_FALSE
+ * @return AXIS2_TRUE if still in use, else AXIS2_FALSE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_op_ctx_set_in_use(
struct axis2_op_ctx *op_ctx,
- const axutil_env_t *env,
+ const axutil_env_t * env,
axis2_bool_t is_in_use);
-
#ifdef __cplusplus
}
---------------------------------------------------------------------
To unsubscribe, e-mail: axis-cvs-unsubscribe@ws.apache.org
For additional commands, e-mail: axis-cvs-help@ws.apache.org