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 09:10:15 UTC
svn commit: r421172 - /webservices/axis2/trunk/c/include/axis2_mep_client.h
Author: pini
Date: Wed Jul 12 00:10:14 2006
New Revision: 421172
URL: http://svn.apache.org/viewvc?rev=421172&view=rev
Log:
Updated doxygen comments to clean doc structure
Modified:
webservices/axis2/trunk/c/include/axis2_mep_client.h
Modified: webservices/axis2/trunk/c/include/axis2_mep_client.h
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/c/include/axis2_mep_client.h?rev=421172&r1=421171&r2=421172&view=diff
==============================================================================
--- webservices/axis2/trunk/c/include/axis2_mep_client.h (original)
+++ webservices/axis2/trunk/c/include/axis2_mep_client.h Wed Jul 12 00:10:14 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_MEP_CLIENT_H
#define AXIS2_MEP_CLIENT_H
+/** @defgroup axis2_mep_client MEP client
+ * @ingroup axis2_client_api
+ * @{
+ */
/**
- * @file axis2_mep_client.h
- * @brief axis2 MEP client interface
- */
+ * @file axis2_mep_client.h
+ * @brief axis2 MEP client interface
+ */
#include <axis2_defines.h>
#include <axis2_env.h>
@@ -35,169 +39,224 @@
{
#endif
-/** @defgroup axis2_mep_client MEP client
- * @ingroup axis2_client_api
- * @{
- */
-
-typedef struct axis2_mep_client_ops axis2_mep_client_ops_t;
-typedef struct axis2_mep_client axis2_mep_client_t;
+ /** Type name for struct axis2_mep_client_ops */
+ typedef struct axis2_mep_client_ops axis2_mep_client_ops_t;
+ /** Type name for struct axis2_mep_client */
+ typedef struct axis2_mep_client axis2_mep_client_t;
+
-
-/**
- * @brief MEP client ops struct
- * Encapsulator struct for ops of axis2_mep_client
- */
-struct axis2_mep_client_ops
-{
- axis2_char_t* (AXIS2_CALL *
- get_soap_action)(struct axis2_mep_client *mep_client,
- const axis2_env_t *env);
/**
- * prepare the message context for invocation, here the properties kept in the
- * MEPClient copied to the axis2_msg_ctx_t *
+ * @brief MEP client ops struct
+ * Encapsulator struct for ops of axis2_mep_client
*/
- axis2_status_t (AXIS2_CALL *
- prepare_invocation)(struct axis2_mep_client *mep_client,
- const axis2_env_t *env,
- axis2_op_t *op,
+ struct axis2_mep_client_ops
+ {
+ /**
+ * @param mep_client pointer to mep client struct
+ * @param env pointer to environment struct
+ */
+ axis2_char_t* (AXIS2_CALL *
+ get_soap_action)(struct axis2_mep_client *mep_client,
+ const axis2_env_t *env);
+ /**
+ * prepare the message context for invocation, here the properties kept in the
+ * MEPClient copied to the axis2_msg_ctx_t *
+ * @param mep_client pointer to mep client struct
+ * @param env pointer to environment struct
+ * @param op pointer to options struct
+ * @param msg_ctx pointer to message context struct
+ * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+ */
+ axis2_status_t (AXIS2_CALL *
+ prepare_invocation)(struct axis2_mep_client *mep_client,
+ const axis2_env_t *env,
+ axis2_op_t *op,
axis2_msg_ctx_t *msg_ctx);
+ /**
+ * This class prepare the SOAP Envelope using the payload
+ * @param mep_client pointer to mep client struct
+ * @param env pointer to environment struct
+ * @param toSend pointer to to send struct
+ * @return a pointer to message context struct
+ */
+ axis2_msg_ctx_t* (AXIS2_CALL *
+ prepare_soap_envelope)(struct axis2_mep_client *mep_client,
+ const axis2_env_t *env,
+ axiom_node_t *to_send);
+ /**
+ * try to infer the transport looking at the URL, the URL can be http://
+ * tcp:// mail:// local://. The method will look for the trnasport name as the
+ * protocol part of the transport.
+ * @param mep_client pointer to mep client struct
+ * @param env pointer to environment struct
+ * @param epr pointer to epr struct
+ * @return
+ */
+ axis2_transport_out_desc_t* (AXIS2_CALL *
+ infer_transport)(struct axis2_mep_client *mep_client,
+ const axis2_env_t *env,
+ axis2_endpoint_ref_t *epr);
+ /**
+ * create write SOAPEvelope(in terms of version) based on the values set.
+ *
+ * @return
+ * @
+ */
+ axiom_soap_envelope_t* (AXIS2_CALL *
+ create_default_soap_envelope)(struct axis2_mep_client *mep_client,
+ const axis2_env_t *env);
+ /**
+ * Engage a given Module to the current invocation. But to call this method the
+ * Module *MUST* be enable (picked up by the deployment and known to Axis2) .
+ * To be detected put the moduels to the AXIS2_REPOSITORY/modules directory
+ *
+ * @param name
+ * @
+ */
+ axis2_status_t (AXIS2_CALL *
+ engage_module)(struct axis2_mep_client *mep_client,
+ const axis2_env_t *env,
+ axis2_qname_t *qname);
+ /**
+ * @param mep_client pointer to mep client struct
+ * @param env pointer to environment struct
+ * @param qname pointer to qname struct
+ */
+ axis2_status_t (AXIS2_CALL *
+ set_soap_version_uri)(struct axis2_mep_client *mep_client,
+ const axis2_env_t *env,
+ axis2_char_t *soap_version_uri);
+ /**
+ * @param mep_client pointer to mep client struct
+ * @param env pointer to environment struct
+ * @param soap_action pointer to soap action struct
+ */
+ axis2_status_t (AXIS2_CALL *
+ set_soap_action)(struct axis2_mep_client *mep_client,
+ const axis2_env_t *env,
+ axis2_char_t *soap_action);
+ /**
+ * @param mep_client pointer to mep client struct
+ * @param env pointer to environment struct
+ * @param wsa_action pointer to was action struct
+ */
+ axis2_status_t (AXIS2_CALL *
+ set_wsa_action)(struct axis2_mep_client *mep_client,
+ const axis2_env_t *env,
+ axis2_char_t *wsa_action);
+
+ /**
+ * @param mep_client pointer to mep client struct
+ * @param env pointer to environment struct
+ */
+ axis2_svc_ctx_t* (AXIS2_CALL *
+ get_svc_ctx)(struct axis2_mep_client *mep_client,
+ const axis2_env_t *env);
+
+ /**
+ * @param mep_client pointer to mep client struct
+ * @param env pointer to environment struct
+ */
+ axis2_status_t (AXIS2_CALL *
+ free)(struct axis2_mep_client *mep_client,
+ const axis2_env_t *env);
+ };
+
/**
- * This class prepare the SOAP Envelope using the payload
- *
- * @param toSend
- * @return
- * @
- */
- axis2_msg_ctx_t* (AXIS2_CALL *
- prepare_soap_envelope)(struct axis2_mep_client *mep_client,
- const axis2_env_t *env,
- axiom_node_t *to_send);
- /**
- * try to infer the transport looking at the URL, the URL can be http://
- * tcp:// mail:// local://. The method will look for the trnasport name as the
- * protocol part of the transport.
- *
- * @param epr
- * @return
- * @
- */
- axis2_transport_out_desc_t* (AXIS2_CALL *
- infer_transport)(struct axis2_mep_client *mep_client,
- const axis2_env_t *env,
- axis2_endpoint_ref_t *epr);
- /**
- * create write SOAPEvelope(in terms of version) based on the values set.
- *
- * @return
- * @
- */
- axiom_soap_envelope_t* (AXIS2_CALL *
- create_default_soap_envelope)(struct axis2_mep_client *mep_client,
- const axis2_env_t *env);
- /**
- * Engage a given Module to the current invocation. But to call this method the
- * Module *MUST* be enable (picked up by the deployment and known to Axis2) .
- * To be detected put the moduels to the AXIS2_REPOSITORY/modules directory
- *
- * @param name
- * @
+ * mep client struct
*/
- axis2_status_t (AXIS2_CALL *
- engage_module)(struct axis2_mep_client *mep_client,
- const axis2_env_t *env,
- axis2_qname_t *qname);
+ struct axis2_mep_client
+ {
+ /** operations of mep client */
+ axis2_mep_client_ops_t *ops;
+ };
+
/**
- * @param string
+ * Creates a mep client struct
+ * @param env pointer to environment struct
+ * @param svc_ctx pointer to service context struct
+ * @param mep pointer to mep struct
*/
- axis2_status_t (AXIS2_CALL *
- set_soap_version_uri)(struct axis2_mep_client *mep_client,
- const axis2_env_t *env,
- axis2_char_t *soap_version_uri);
+ AXIS2_EXTERN axis2_mep_client_t* AXIS2_CALL axis2_mep_client_create(const axis2_env_t *env,
+ axis2_svc_ctx_t *svc_ctx,
+ const axis2_char_t *mep);
+
+
/**
- * @param string
+ * @param env pointer to environment struct
+ * @param msg_ctx pointer to message context struct
*/
- axis2_status_t (AXIS2_CALL *
- set_soap_action)(struct axis2_mep_client *mep_client,
- const axis2_env_t *env,
- axis2_char_t *soap_action);
+ axis2_msg_ctx_t* AXIS2_CALL
+ axis2_mep_client_two_way_send(const axis2_env_t *env,
+ axis2_msg_ctx_t *msg_ctx);
+
/**
- * @param string
+ * @param env pointer to environment struct
+ * @param msg_ctx pointer to message context struct
*/
- axis2_status_t (AXIS2_CALL *
- set_wsa_action)(struct axis2_mep_client *mep_client,
- const axis2_env_t *env,
- axis2_char_t *wsa_action);
-
-
- axis2_svc_ctx_t* (AXIS2_CALL *
- get_svc_ctx)(struct axis2_mep_client *mep_client,
- const axis2_env_t *env);
-
-
- axis2_status_t (AXIS2_CALL *
- free)(struct axis2_mep_client *mep_client,
- const axis2_env_t *env);
-};
-
-/**
- * @brief MEP client struct
- * Axis2 MEP client
- */
-struct axis2_mep_client
-{
- axis2_mep_client_ops_t *ops;
-};
+ axis2_msg_ctx_t* AXIS2_CALL
+ axis2_mep_client_receive(const axis2_env_t *env,
+ axis2_msg_ctx_t *msg_ctx);
-AXIS2_EXTERN axis2_mep_client_t* AXIS2_CALL axis2_mep_client_create(const axis2_env_t *env,
- axis2_svc_ctx_t *svc_ctx,
- const axis2_char_t *mep);
-
-axis2_msg_ctx_t* AXIS2_CALL
-axis2_mep_client_two_way_send(const axis2_env_t *env,
- axis2_msg_ctx_t *msg_ctx);
-
-axis2_msg_ctx_t* AXIS2_CALL
-axis2_mep_client_receive(const axis2_env_t *env,
- axis2_msg_ctx_t *msg_ctx);
-
/************************** Start of function macros **************************/
+/** Gets the soap action.
+ @sa axis2_mep_client_ops#get_soap_action */
#define AXIS2_MEP_CLIENT_GET_SOAP_ACTION(mep_client, env) \
((mep_client)->ops->get_soap_action(mep_client, env))
+/** Prepare invocation.
+ @sa axis2_mep_client_ops#prepare_invocation */
#define AXIS2_MEP_CLIENT_PREPARE_INVOCATION(mep_client, env, op, msg_ctx) \
((mep_client)->ops->prepare_invocation(mep_client, env, op, msg_ctx))
+/** Prepares the soap envelope.
+ @sa axis2_mep_client_ops#prepare_soap_envelope */
#define AXIS2_MEP_CLIENT_PREPARE_SOAP_ENVELOPE(mep_client, env, to_send) \
((mep_client)->ops->prepare_soap_envelope(mep_client, env, to_send))
+/** Infer transport.
+ @sa axis2_mep_client_ops#infer_transport */
#define AXIS2_MEP_CLIENT_INFER_TRANSPORT(mep_client, env, epr) \
((mep_client)->ops->infer_transport(mep_client, env, epr))
-
+
+/** Creates the default soap envelope.
+ @sa axis2_mep_client_ops#create_default_soap_envelope */
#define AXIS2_MEP_CLIENT_CREATE_DEFAULT_SOAP_ENVELOPE(mep_client, env) \
((mep_client)->ops->create_default_soap_envelope(mep_client, env))
-
+
+/** Engages the module.
+ @sa axis2_mep_client_ops#engage_module */
#define AXIS2_MEP_CLIENT_ENGAGE_MODULE(mep_client, env, qname) \
((mep_client)->ops->engage_module(mep_client, env, qname))
-
+
+/** Sets the soap version uri.
+ @sa axis2_mep_client_ops#set_soap_version_uri */
#define AXIS2_MEP_CLIENT_SET_SOAP_VERSION_URI(mep_client, env, soap_version_uri)\
((mep_client)->ops->set_soap_version_uri(mep_client, env, soap_version_uri))
-
+
+/** Sets the soap action.
+ @sa axis2_mep_client_ops#set_soap_action */
#define AXIS2_MEP_CLIENT_SET_SOAP_ACTION(mep_client, env, soap_action) \
((mep_client)->ops->set_soap_action(mep_client, env, soap_action))
-
+
+/** Sets the wsa action.
+ @sa axis2_mep_client_ops#set_wsa_action*/
#define AXIS2_MEP_CLIENT_SET_WSA_ACTION(mep_client, env, wsa_action) \
((mep_client)->ops->set_wsa_action(mep_client, env, wsa_action))
-
+
+/** Gets the service context.
+ @sa axis2_mep_client_ops#get_svc_ctx*/
#define AXIS2_MEP_CLIENT_GET_SVC_CTX(mep_client, env) \
((mep_client)->ops->get_svc_ctx(mep_client, env))
-
+
+/** Free.
+ @sa axis2_mep_client_ops#free*/
#define AXIS2_MEP_CLIENT_FREE(mep_client, env) \
((mep_client)->ops->free (mep_client, 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