From 0425aadc78680e53000fd0108b540d6eca048516 Mon Sep 17 00:00:00 2001 From: gmcdonald Date: Sat, 13 Feb 2010 01:32:03 +0000 Subject: Moving axis svn, part of TLP move INFRA-2441 git-svn-id: http://svn.apache.org/repos/asf/axis/axis2/c/core/trunk@909681 13f79535-47bb-0310-9956-ffa450edef68 --- include/axis2_transport_in_desc.h | 329 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 329 insertions(+) create mode 100644 include/axis2_transport_in_desc.h (limited to 'include/axis2_transport_in_desc.h') diff --git a/include/axis2_transport_in_desc.h b/include/axis2_transport_in_desc.h new file mode 100644 index 0000000..bd96331 --- /dev/null +++ b/include/axis2_transport_in_desc.h @@ -0,0 +1,329 @@ + +/* +* Licensed to the Apache Software Foundation (ASF) under one or more +* contributor license agreements. See the NOTICE file distributed with +* this work for additional information regarding copyright ownership. +* The ASF licenses this file to You 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_TRANSPORT_IN_DESC_H +#define AXIS2_TRANSPORT_IN_DESC_H + +/** + * @defgroup axis2_transport_in_desc transport in description + * @ingroup axis2_desc + * transport in description represents a transport receiver configured in + * Axis2 configuration. There can be multiple transport receivers configured + * in axis2.xml file and each of them will be represented with a transport + * in description instance. deployment engine takes care of creating and + * instantiating transport in descriptions. + * transport in description encapsulates flows related to the transport in + * and also holds a reference to related transport receiver. + * @{ + */ + +/** + * @file axis2_transport_in_desc.h + * @brief Axis2 description transport in interface + */ + +#include +#include +#include +#include +#include +#include + +/*#include */ +#include +#include +#include + +#ifdef __cplusplus +extern "C" +{ +#endif + + /** Type name for struct axis2_transport_in_desc */ + typedef struct axis2_transport_in_desc axis2_transport_in_desc_t; + + struct axis2_phase; + struct axis2_transport_receiver; + + /** + * Frees transport in description. + * @param transport_in_desc pointer to transport in description struct + * @param env pointer to environment struct + * @return void + */ + AXIS2_EXTERN void AXIS2_CALL + axis2_transport_in_desc_free( + axis2_transport_in_desc_t * transport_in_desc, + const axutil_env_t * env); + + /** + * Frees transport in description given as a void parameter. + * @param transport_in pointer to transport in description as a void + * pointer + * @param env pointer to environment struct + * @return void + */ + AXIS2_EXTERN void AXIS2_CALL + axis2_transport_in_desc_free_void_arg( + void *transport_in, + const axutil_env_t * env); + + /** + * Gets transport enum. + * @param transport_in pointer to transport in description struct + * @param env pointer to environment struct + * @return transport enum + */ + AXIS2_EXTERN AXIS2_TRANSPORT_ENUMS AXIS2_CALL + + axis2_transport_in_desc_get_enum( + const axis2_transport_in_desc_t * transport_in, + const axutil_env_t * env); + + /** + * Sets transport enum. + * @param transport_in pointer to transport in description struct + * @param env pointer to environment struct + * @param trans_enum transport enum + * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE + */ + AXIS2_EXTERN axis2_status_t AXIS2_CALL + axis2_transport_in_desc_set_enum( + struct axis2_transport_in_desc *transport_in, + const axutil_env_t * env, + const AXIS2_TRANSPORT_ENUMS trans_enum); + + /** + * Gets in flow. In flow represents the list of phases invoked + * along the receive path. + * @param transport_in pointer to transport in description struct + * @param env pointer to environment struct + * @return pointer to flow representing in flow, returns a reference, + * not a cloned copy + */ + AXIS2_EXTERN struct axis2_flow *AXIS2_CALL + + axis2_transport_in_desc_get_in_flow( + const axis2_transport_in_desc_t * transport_in, + const axutil_env_t * env); + + /** + * Sets in flow. In flow represents the list of phases invoked + * along the receive path. + * @param transport_in pointer to transport in description struct + * @param env pointer to environment struct + * @param in_flow pointer to in flow representing in flow, transport in + * description assumes ownership of the flow + * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE + */ + AXIS2_EXTERN axis2_status_t AXIS2_CALL + + axis2_transport_in_desc_set_in_flow( + struct axis2_transport_in_desc *transport_in, + const axutil_env_t * env, + struct axis2_flow *in_flow); + + /** + * Gets fault in flow. Fault in flow represents the list of phases + * invoked along the receive path if a fault happens. + * @param transport_in pointer to transport in description struct + * @param env pointer to environment struct + * @return pointer to flow representing fault in flow, returns a + * reference, not a cloned copy + */ + AXIS2_EXTERN struct axis2_flow *AXIS2_CALL + + axis2_transport_in_desc_get_fault_in_flow( + const axis2_transport_in_desc_t * transport_in, + const axutil_env_t * env); + + /** + * Sets fault in flow. Fault in flow represents the list of phases + * invoked along the receive path if a fault happens. + * @param transport_in pointer to transport in description struct + * @param env pointer to environment struct + * @param fault_in_flow pointer to flow representing fault in flow, + * transport in description assumes the ownership of the flow + * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE + */ + AXIS2_EXTERN axis2_status_t AXIS2_CALL + + axis2_transport_in_desc_set_fault_in_flow( + struct axis2_transport_in_desc *transport_in, + const axutil_env_t * env, + struct axis2_flow *fault_in_flow); + + /** + * Gets transport receiver associated with the transport in description. + * @param transport_in pointer to transport in description struct + * @param env pointer to environment struct + * @return pointer to transport receiver, returns a reference, not + * a cloned copy + */ + AXIS2_EXTERN struct axis2_transport_receiver *AXIS2_CALL + + axis2_transport_in_desc_get_recv( + const axis2_transport_in_desc_t * transport_in, + const axutil_env_t * env); + + /** + * Sets transport receiver associated with the transport in description. + * @param transport_in pointer to transport in description struct + * @param env pointer to environment struct + * @param recv pointer to transport receiver, transport in + * description assumes ownership of the receiver + * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE + */ + AXIS2_EXTERN axis2_status_t AXIS2_CALL + axis2_transport_in_desc_set_recv( + struct axis2_transport_in_desc *transport_in, + const axutil_env_t * env, + struct axis2_transport_receiver *recv); + + /** + * Gets the transport in phase associated with transport in description. + * @param transport_in pointer to transport in description struct + * @param env pointer to environment struct + * @return transport in phase, returns a reference, not a cloned copy + */ + AXIS2_EXTERN struct axis2_phase *AXIS2_CALL + + axis2_transport_in_desc_get_in_phase( + const axis2_transport_in_desc_t * transport_in, + const axutil_env_t * env); + + /** + * Sets the transport in phase associated with transport in description. + * @param transport_in pointer to transport in description struct + * @param env pointer to environment struct + * @param in_phase pointer to phase representing transport in phase, + * transport in description assumes ownership of phase + * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE + */ + AXIS2_EXTERN axis2_status_t AXIS2_CALL + + axis2_transport_in_desc_set_in_phase( + struct axis2_transport_in_desc *transport_in, + const axutil_env_t * env, + struct axis2_phase *in_phase); + + /** + * Gets the transport fault phase associated with transport in description. + * @param transport_in pointer to transport in description struct + * @param env pointer to environment struct + * @return pointer to phase representing fault phase + */ + AXIS2_EXTERN struct axis2_phase *AXIS2_CALL + + axis2_transport_in_desc_get_fault_phase( + const axis2_transport_in_desc_t * transport_in, + const axutil_env_t * env); + + /** + * Sets the transport fault phase associated with transport in description. + * @param transport_in pointer to transport in description struct + * @param env pointer to environment struct + * @param fault_phase pointer to fault phase + * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE + */ + AXIS2_EXTERN axis2_status_t AXIS2_CALL + + axis2_transport_in_desc_set_fault_phase( + struct axis2_transport_in_desc *transport_in, + const axutil_env_t * env, + struct axis2_phase *fault_phase); + + /** + * Adds given parameter. + * @param transport_in_desc pointer to transport in description struct + * @param env pointer to environment struct + * @param param pointer to parameter, transport in description assumes + * ownership of parameter + * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE + */ + AXIS2_EXTERN axis2_status_t AXIS2_CALL + axis2_transport_in_desc_add_param( + axis2_transport_in_desc_t * transport_in_desc, + const axutil_env_t * env, + axutil_param_t * param); + + /** + * Gets named parameter. + * @param transport_in_desc pointer to transport in description struct + * @param env pointer to environment struct + * @param param_name parameter name string + * @return pointer to named parameter if it exists, else NULL. Returns + * a reference, not a cloned copy + */ + AXIS2_EXTERN axutil_param_t *AXIS2_CALL + + axis2_transport_in_desc_get_param( + const axis2_transport_in_desc_t * transport_in_desc, + const axutil_env_t * env, + const axis2_char_t * param_name); + + /** + * Checks if the named parameter is locked. + * @param transport_in_desc pointer to transport in description struct + * @param env pointer to environment struct + * @param param_name parameter name string + * @return AXIS2_TRUE if named parameter is locked, else AXIS2_FALSE + */ + AXIS2_EXTERN axis2_bool_t AXIS2_CALL + + axis2_transport_in_desc_is_param_locked( + axis2_transport_in_desc_t * transport_in_desc, + const axutil_env_t * env, + const axis2_char_t * param_name); + + AXIS2_EXTERN axutil_param_container_t *AXIS2_CALL + + axis2_transport_in_desc_param_container( + const axis2_transport_in_desc_t * transport_in_desc, + const axutil_env_t * env); + + /** + * Creates transport in description with given transport enum. + * @param env pointer to environment struct + * @param trans_enum transport enum + * @return pointer to newly created phase holder + */ + AXIS2_EXTERN axis2_transport_in_desc_t *AXIS2_CALL + + axis2_transport_in_desc_create( + const axutil_env_t * env, + const AXIS2_TRANSPORT_ENUMS trans_enum); + + /** + * Frees transport in description given as a void parameter. + * @param transport_in pointer to transport in description as a void + * pointer + * @param env pointer to environment struct + * @return void + */ + AXIS2_EXTERN void AXIS2_CALL + axis2_transport_in_desc_free_void_arg( + void *transport_in, + const axutil_env_t * env); + + /** @} */ + +#ifdef __cplusplus +} +#endif +#endif /* AXIS2_TRANSPORT_IN_DESC_H */ -- cgit v1.1-32-gdbae