axiom/src/attachments/axiom_mime_body_part.h

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

/**
 * @file axiom_mime_body_part.h
 * @brief axis2 mime_body_part interface
 */

#include <axutil_utils.h>
#include <axutil_error.h>
#include <axutil_utils_defines.h>
#include <axutil_env.h>
#include <axutil_allocator.h>
#include <axutil_string.h>
#include <axutil_array_list.h>
#include <axiom_data_handler.h>
#include <axiom_text.h>
#include <axiom_mime_const.h>

#ifdef __cplusplus
extern "C"
{
#endif

    typedef struct axiom_mime_body_part axiom_mime_body_part_t;

    /** @defgroup axiom_mime_body_part
      * @ingroup axiom_mime_body_part
      * @{
      */

    AXIS2_EXTERN axis2_status_t AXIS2_CALL
    axiom_mime_body_part_add_header(
        axiom_mime_body_part_t * mime_body_part,
        const axutil_env_t * env,
        const axis2_char_t * name,
        const axis2_char_t * value);

    AXIS2_EXTERN axis2_status_t AXIS2_CALL

    axiom_mime_body_part_set_data_handler(
        axiom_mime_body_part_t * mime_body_part,
        const axutil_env_t * env,
        axiom_data_handler_t * data_handler);

    AXIS2_EXTERN axis2_status_t AXIS2_CALL
    axiom_mime_body_part_write_to(
        axiom_mime_body_part_t * mime_body_part,
        const axutil_env_t * env,
        axis2_byte_t ** output_stream,
        int *output_stream_size);

    /** Deallocate memory
      * @return status code
      */
    AXIS2_EXTERN void AXIS2_CALL
    axiom_mime_body_part_free(
        axiom_mime_body_part_t * mime_body_part,
        const axutil_env_t * env);
    
    AXIS2_EXTERN axis2_status_t AXIS2_CALL
        axiom_mime_body_part_write_to_list(
        axiom_mime_body_part_t *mime_body_part,
        const axutil_env_t *env,
        axutil_array_list_t *list);

    /**
     * Creates mime_body_part struct
     * @return pointer to newly created mime_body_part
     */
    AXIS2_EXTERN axiom_mime_body_part_t *AXIS2_CALL
    axiom_mime_body_part_create(
        const axutil_env_t * env);
    
    /**
     * Creates mime_body_part struct from a om_text
     * @return pointer to newly created mime_body_part
     */
    
    AXIS2_EXTERN axiom_mime_body_part_t *AXIS2_CALL 
    axiom_mime_body_part_create_from_om_text(
        const axutil_env_t *env,    
        axiom_text_t *text);
        
    /** @} */

#ifdef __cplusplus
}
#endif
#endif                          /* AXIOM_MIME_BODY_PART_H */