include/axis2_soap_over_http_sender.h

/*
 * 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_SOAP_OVER_HTTP_SENDER_H
#define AXIS2_SOAP_OVER_HTTP_SENDER_H

/**
 * @ingroup axis2_core_transport_http
 * @{
 */

/**
 * @file axis2_soap_over_http_sender.h
 * @brief axis2 SOAP over HTTP sender
 */

#include <axis2_const.h>
#include <axis2_defines.h>
#include <axis2_env.h>
#include <axis2_msg_ctx.h>
#include <axiom_output.h>
#include <axis2_http_simple_response.h>
#include <axiom_soap_envelope.h>


#ifdef __cplusplus
extern "C"
{
#endif

    /** Type name for struct axis2_soap_over_http_sender_ops */
    typedef struct axis2_soap_over_http_sender_ops
                axis2_soap_over_http_sender_ops_t;
    /** Type name for struct axis2_soap_over_http_sender_ */
    typedef struct axis2_soap_over_http_sender axis2_soap_over_http_sender_t;


    /**
     * SOAP over HTTP sender ops struct
     * Encapsulator struct for ops of axis2_soap_over_http_sender
     */
    struct axis2_soap_over_http_sender_ops
    {
        /**
         * @param sender sender
         * @param env pointer to environment struct
         * @param msg_ctx pointer to message context
         * @param out out
         * @param str_url str url
         * @param soap_action pointer to soap action
         * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
         */
        axis2_status_t (AXIS2_CALL *
                send)(
                    axis2_soap_over_http_sender_t *sender,
                    const axis2_env_t *env, 
                    axis2_msg_ctx_t *msg_ctx,
                    axiom_soap_envelope_t *out,
                    const axis2_char_t *str_url,
                    const axis2_char_t *soap_action);

        /**
         * @param sender sender
         * @param env pointer to environment struct
         * @param chunked chunked
         * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
         */
        axis2_status_t (AXIS2_CALL *
                set_chunked)(
                    axis2_soap_over_http_sender_t *sender,
                    const axis2_env_t *env, 
                    axis2_bool_t chunked);

        /**
         * @param sender sender
         * @param env pointer to environment struct
         * @param om_output om output
         * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
         */
        axis2_status_t (AXIS2_CALL *
                set_om_output)(
                    axis2_soap_over_http_sender_t *sender,
                    const axis2_env_t *env, 
                    axiom_output_t *om_output);

        /**
         * @param sender sender
         * @param env pointer to environment struct
         * @param version pointer to version
         * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
         */
        axis2_status_t (AXIS2_CALL *
                set_http_version)(
                    axis2_soap_over_http_sender_t *sender,
                    const axis2_env_t *env, 
                    axis2_char_t *version);

        /**
         * @param sender sender
         * @param env pointer to environment struct
         * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
         */
        axis2_status_t (AXIS2_CALL *
                free)(
                    axis2_soap_over_http_sender_t *sender,
                    const axis2_env_t *env);
    };


    /**
     * @param sender soap over http sender
     * @param env pointer to environment struct
     * @param msg_ctx pointer to message context
     * @param response pointer to response
     */
    axis2_status_t AXIS2_CALL
    axis2_soap_over_http_sender_get_header_info(
        axis2_soap_over_http_sender_t *sender,
        const axis2_env_t *env, 
        axis2_msg_ctx_t *msg_ctx,
        axis2_http_simple_response_t *response);

    /**
     * @param sender soap over http sender
     * @param env pointer to environment struct
     * @param msg_ctx pointer to message context
     * @param response pointer to response
     */
    axis2_status_t AXIS2_CALL
    axis2_soap_over_http_sender_process_response(
        axis2_soap_over_http_sender_t *sender,
        const axis2_env_t *env, 
        axis2_msg_ctx_t *msg_ctx,
        axis2_http_simple_response_t *response);


    /**
     * @param sender soap over http sender
     * @param env pointer to environment struct
     * @param msg_ctx pointer to message context
     */
    axis2_status_t AXIS2_CALL
    axis2_soap_over_http_sender_get_timeout_values(
        axis2_soap_over_http_sender_t *sender,
        const axis2_env_t *env, 
        axis2_msg_ctx_t *msg_ctx);

    /**
     * Axis2 SOAP over HTTP sender
     */
    struct axis2_soap_over_http_sender
    {
        /** Operations of Axis2 SOAP over HTTP sender */
        axis2_soap_over_http_sender_ops_t *ops;
    };


    /**
     * @param env pointer to environment struct
     */
    AXIS2_EXTERN axis2_soap_over_http_sender_t *AXIS2_CALL
    axis2_soap_over_http_sender_create(
        const axis2_env_t *env);

/********************* Start of function macros   ***************************/

/** Send.
    @sa axis2_soap_over_http_sender_ops#send */
#define AXIS2_SOAP_OVER_HTTP_SENDER_SEND(sender, env, msg_ctx, output, url, \
                  soap_action) ((sender)->ops->send (sender, env, msg_ctx\
                  ,output, url, soap_action))

/** Set chunked.
    @sa axis2_soap_over_http_sender_ops#set_chunked */
#define AXIS2_SOAP_OVER_HTTP_SENDER_SET_CHUNKED(sender, env, chunked) \
                        ((sender)->ops->set_chunked(sender, env, chunked))

/** Set om output.
    @sa axis2_soap_over_http_sender_ops#set_om_output */
#define AXIS2_SOAP_OVER_HTTP_SENDER_SET_OM_OUTPUT(sender, env, om_output) \
                        ((sender)->ops->set_om_output (sender, env, om_output))

/** Set http version.
    @sa axis2_soap_over_http_sender_ops#set_http_version */
#define AXIOM_SOAP_OVER_SENDER_SET_HTTP_VERSION(sender, env, version)\
                        ((sender)->ops->set_http_version (sender, env, version))

/** Frees the soap over http sender.
    @sa axis2_soap_over_http_sender_ops#free */
#define AXIS2_SOAP_OVER_HTTP_SENDER_FREE(sender, env) \
                        ((sender)->ops->free(sender, env))

/************************* End of function macros *****************************/

/** @} */
#ifdef __cplusplus
}
#endif
#endif /* AXIS2_SOAP_OVER_HTTP_SENDER_H */