include/axis2_msg_recv.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_MSG_RECV_H
#define AXIS2_MSG_RECV_H


/**
  * @file axis2_msg_recv.h
  * @brief axis Message Receiver interface
  */

#include <axis2_core.h>

#ifdef __cplusplus
extern "C"
{
#endif

/** @defgroup axis2_msg_recv Message Receiver
  * @ingroup axis2_core_engine
  * @{
  */

struct axis2_msg_ctx_s;
typedef struct axis2_msg_recv axis2_msg_recv_t;
typedef struct axis2_msg_recv_ops axis2_msg_recv_ops_t;

/** 
 * @brief Message Receiver operations struct
 * Encapsulator struct for operations of axis2_msg_recv
 */     
struct axis2_msg_recv_ops
{
    /** 
     * Deallocate memory
     * @return status code
     */
    axis2_status_t (AXIS2_CALL *free) (axis2_msg_recv_t *msg_recv,
                                        axis2_env_t **env);

    axis2_status_t (AXIS2_CALL *receive) (axis2_msg_recv_t *msg_recv,
                                            axis2_env_t **env,
                                            struct axis2_msg_ctx_s *msg_ctx);
};

/** 
 * @brief Message Receiver struct
  *	Axis2 Message Receiver
 */
struct axis2_msg_recv
{
    axis2_msg_recv_ops_t *ops;    
};

AXIS2_DECLARE(axis2_msg_recv_t *)
axis2_msg_recv_create (axis2_env_t **env);

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

#define AXIS2_MSG_RECV_FREE(msg_recv, env) (msg_recv->ops->free (msg_recv, env));

#define AXIS2_MSG_RECV_RECEIVE(msg_recv, env, msg_ctx) \
		(msg_recv->ops->receive (msg_recv, env, msg_ctx));

/************************** End of function macros ****************************/
    
/** @} */
#ifdef __cplusplus
}
#endif

#endif                          /* AXIS2_MSG_RECV_H */