You are viewing a plain text version of this content. The canonical link for it is here.
Posted to sandesha-dev@ws.apache.org by da...@apache.org on 2006/07/17 05:43:27 UTC
svn commit: r422612 -
/webservices/sandesha/trunk/c/include/sandesha2_client.h
Author: damitha
Date: Sun Jul 16 20:43:26 2006
New Revision: 422612
URL: http://svn.apache.org/viewvc?rev=422612&view=rev
Log:
Added new file
Added:
webservices/sandesha/trunk/c/include/sandesha2_client.h
Added: webservices/sandesha/trunk/c/include/sandesha2_client.h
URL: http://svn.apache.org/viewvc/webservices/sandesha/trunk/c/include/sandesha2_client.h?rev=422612&view=auto
==============================================================================
--- webservices/sandesha/trunk/c/include/sandesha2_client.h (added)
+++ webservices/sandesha/trunk/c/include/sandesha2_client.h Sun Jul 16 20:43:26 2006
@@ -0,0 +1,194 @@
+/*
+ * 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 SANDESHA2_CLIENT_H
+#define SANDESHA2_CLIENT_H
+
+/**
+ * @file sandesha2_client.h
+ * @brief Sandesha Client Interface
+ */
+
+#include <axis2_allocator.h>
+#include <axis2_env.h>
+#include <axis2_error.h>
+#include <axis2_string.h>
+#include <axis2_utils.h>
+#include <axis2_hash.h>
+#include <axis2_uri.h>
+#include <axis2_array_list.h>
+#include <axis2_svc_client.h>
+
+#include <sandesha2_seq_report.h>
+#include <sandesha2_report.h>
+
+#ifdef __cplusplus
+extern "C"
+{
+#endif
+
+/** @defgroup sandesha2_client Client
+ * @ingroup sandesha2
+ * @{
+ */
+sandesha2_seq_report_t *AXIS2_CALL
+sandesha2_client_get_outgoing_seq_report_with_svc_client(
+ const axis2_env_t *env,
+ axis2_svc_client_t *svc_client);
+
+sandesha2_seq_report_t *AXIS2_CALL
+sandesha2_client_get_outgoing_seq_report_with_seq_key(
+ const axis2_env_t *env,
+ axis2_char_t *to,
+ axis2_char_t *seq_key,
+ axis2_conf_ctx_t *conf_ctx);
+
+sandesha2_seq_report_t *AXIS2_CALL
+sandesha2_client_get_outgoing_seq_report_with_internal_seq_id(
+ const axis2_env_t *env,
+ axis2_char_t *internal_seq_id,
+ axis2_conf_ctx_t *conf_ctx);
+
+/**
+ * Users can get a list of seq_reports each describing a incoming
+ * sequence, which are the sequences the client work as a RMD.
+ * Caller must free the returned array.
+ *
+ * @param config_ctx
+ * @return
+ */
+axis2_array_list_t *AXIS2_CALL
+sandesha2_client_get_incoming_seq_reports(
+ axis2_env_t *env,
+ axis2_conf_ctx_t *conf_ctx);
+
+/**
+ * sandesha2_report gives the details of all incoming and outgoing sequences.
+ * The outgoing sequence have to pass the initial state (CS/CSR exchange) to
+ * be included in a sandesha2_report
+ *
+ * @param conf_ctx
+ * @return
+ */
+sandesha2_report_t *AXIS2_CALL
+sandesha2_client_get_report(
+ const axis2_env_t *env,
+ axis2_conf_ctx_t *conf_ctx);
+
+axis2_status_t AXIS2_CALL
+sandesha2_client_create_seq_with_svc_client(
+ const axis2_env_t *env,
+ axis2_svc_client_t *svc_client,
+ axis2_bool_t offer);
+
+axis2_status_t AXIS2_CALL
+sandesha2_client_create_seq_with_svc_client_and_seq_key(
+ const axis2_env_t *env,
+ axis2_svc_client_t *svc_client,
+ axis2_bool_t offer,
+ axis2_char_t *seq_key);
+
+/**
+ * User can terminate the sequence defined by the passed svc_client.
+ *
+ * @param svc_client
+ */
+axis2_status_t AXIS2_CALL
+sandesha2_client_terminate_seq_with_svc_client(
+ const axis2_env_t *env,
+ axis2_svc_client_t *svc_client);
+
+axis2_status_t AXIS2_CALL
+sandesha2_client_terminate_seq_with_svc_client_and_seq_key(
+ const axis2_env_t *env,
+ axis2_svc_client_t *svc_client,
+ axis2_char_t *seq_key);
+
+/**
+ * User can close the seq defined by the passed svc_client.
+ *
+ * @param svc_client
+ */
+axis2_status_t AXIS2_CALL
+sandesha2_client_close_seq_with_svc_client(
+ const axis2_env_t *env,
+ axis2_svc_client_t *svc_client);
+
+axis2_status_t AXIS2_CALL
+sandesha2_client_close_seq_with_svc_client_and_seq_key(
+ const axis2_env_t *env,
+ axis2_svc_client_t *svc_client,
+ axis2_char_t *seq_key);
+
+/**
+ * This blocks the system until the messages sent have been completed.
+ *
+ * @param svc_client
+ */
+axis2_status_t AXIS2_CALL
+sandesha2_client_wait_until_seq_completed_with_svc_client(
+ const axis2_env_t *env,
+ axis2_svc_client_t *svc_client);
+
+axis2_status_t AXIS2_CALL
+sandesha2_client_wait_until_seq_completed_with_svc_client_and_seq_key(
+ const axis2_env_t *env,
+ axis2_svc_client_t *svc_client,
+ axis2_char_t *seq_key);
+
+/**
+ * This blocks the system until the messages sent have been completed
+ * or until the given time interval exceeds. (the time is taken in seconds)
+ *
+ * @param svc_client
+ * @param max_waiting_time
+ */
+axis2_status_t AXIS2_CALL
+sandesha2_client_wait_until_seq_completed_with_svc_client_and_max_waiting_time(
+ const axis2_env_t *env,
+ axis2_svc_client_t *svc_client,
+ long max_waiting_time);
+
+axis2_status_t AXIS2_CALL
+sandesha2_client_wait_until_seq_completed_with_svc_client_and_max_waiting_time_and_seq_key(
+ const axis2_env_t *env,
+ axis2_svc_client_t *svc_client,
+ long max_waiting_time,
+ axis2_char_t *seq_key);
+
+/*
+ * gives the out seqID if CS/CSR exchange is done. Otherwise an error
+ */
+axis2_char_t *AXIS2_CALL
+sandesha2_client_get_seq_id(
+ const axis2_env_t *env,
+ axis2_svc_client_t *svc_client);
+
+axis2_status_t AXIS2_CALL
+sandesha2_client_send_ack_request_with_svc_client(
+ const axis2_env_t *env,
+ axis2_svc_client_t *svc_client);
+
+axis2_status_t AXIS2_CALL
+sandesha2_client_send_ack_request_with_svc_client_and_seq_key(
+ const axis2_env_t *env,
+ axis2_svc_client_t *svc_client,
+ axis2_char_t *seq_key);
+
+#ifdef __cplusplus
+}
+#endif
+#endif /* SANDESHA2_CLIENT_H */
---------------------------------------------------------------------
To unsubscribe, e-mail: sandesha-dev-unsubscribe@ws.apache.org
For additional commands, e-mail: sandesha-dev-help@ws.apache.org