/*
 *                         OpenSplice DDS
 *
 *   This software and documentation are Copyright 2006 to 2009 PrismTech 
 *   Limited and its licensees. All rights reserved. See file:
 *
 *                     $OSPL_HOME/LICENSE 
 *
 *   for full copyright notice and license terms. 
 *
 */
#ifndef V_CMSOAP_H
#define V_CMSOAP_H

/** \file kernel/include/v_cmsoap.h
 *  \brief This file defines the interface
 *
 */

#include "kernelModule.h"

#if defined (__cplusplus)
extern "C" {
#endif
#include "os_if.h"

#ifdef OSPL_BUILD_KERNEL
#define OS_API OS_API_EXPORT
#else
#define OS_API OS_API_IMPORT
#endif
/* !!!!!!!!NOTE From here no more includes are allowed!!!!!!! */

/**
 * \brief The <code>v_cmsoap</code> cast method.
 *
 * This method casts an object to a <code>v_cmsoap</code> object.
 * Before the cast is performed, if compiled with the NDEBUG flag not set,
 * the type of the object is checked to be <code>v_cmsoap</code> or
 * one of its subclasses.
 */
#define v_cmsoap(o) (C_CAST(o,v_cmsoap))

/**
 * \brief The <code>v_cmsoapNew</code> constructor.
 *
 * This method creates a soap service participant.
 *
 * Currently this class is part of the kernel but as being a pluggable service
 * This definition should be part of the service itself.
 *
 * \param name           the participant name of the service
 * \param extStateName   the name by which the service state is identified.
 *                       the state will be made accessible via this name.
 * \param qos            the service participant QoS policy values.
 *
 * \return <code>NULL</code> if construction fails, otherwise
 *         a reference to a newly instantiated service object.
 */
OS_API v_cmsoap
v_cmsoapNew(
    v_serviceManager manager,
    const c_char *name,
    const c_char *extStateName,
    v_participantQos qos);

/**
 * \brief The <code>v_cmsoapFree</code> destructor.
 *
 * This method destroys the soap service participant.
 *
 * \param _this  the service to be destroyed.
 *
 */
OS_API void
v_cmsoapFree(
    v_cmsoap cms);

#undef OS_API

#if defined (__cplusplus)
}
#endif

#endif
