ProprietaryApi.hpp

Go to the documentation of this file.

/*
 *                         Vortex OpenSplice
 *
 *   This software and documentation are Copyright 2006 to 2021 ADLINK
 *   Technology Limited, its affiliated companies and licensors. All rights
 *   reserved.
 *
 *   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 OMG_DDS_CORE_DETAIL_PROPRIETARY_API_HPP_
#define OMG_DDS_CORE_DETAIL_PROPRIETARY_API_HPP_

/*
 * There are two parts in the IsoCpp API:
 *   - Specification API (include/dds)
 *   - Proprietary API   (include/org)
 * However, include/org mostly contains implementation details and only a small
 * part is API for the application.
 *
 * There are basically two ways of including the proprietary API into the API
 * documentation generated by doxygen.
 *
 * 1) Add include/org to the doxygen input directories and filter out the
 *    non-API information (see doxygen_isocpp2_*.cfg files)
 *      Advantage -
 *          Documentation is at the same place as the implementation.
 *      Disadvantage -
 *          The non-API filtering can be done by either changing the doxygen
 *          config files or adding cond/endcond tags all through the header
 *          files. Both will be quite cumbersome.
 * 2) Add a header file to include/dds that contains the documentation for the
 *    proprietary part of the API.
 *      Advantage -
 *          Simple.
 *      Disadvantage -
 *          Documentation is in a different place as the implementation.
 *
 * Option 2 is choosen (obviously, because you're looking at that actual
 * proprietary API documentation file).
 */

#ifdef DOXYGEN_FOR_ISOCPP2
/*
 * The above macro is never (and must never) be defined in normal compilation.
 *
 * The following code is only for documentation purposes.
 */


namespace org {
namespace opensplice {



namespace topic {

    template <typename T>
    class TopicListener : public dds::topic::TopicListener<T>
    {
    public:
        virtual void on_all_data_disposed(
            dds::topic::Topic<T>& topic,
            const org::opensplice::core::status::AllDataDisposedTopicStatus& status) = 0;
    };

    template <typename T>
    class NoOpTopicListener : public virtual TopicListener<T>
    { };

    class AnyTopicListener : public virtual dds::topic::AnyTopicListener
    {
    public:
        virtual void on_all_data_disposed(
            dds::topic::AnyTopic& topic,
            const org::opensplice::core::status::AllDataDisposedTopicStatus& status) = 0;
    };

    class NoOpAnyTopicListener : public virtual AnyTopicListener
    { };


    class CMParticipantBuiltinTopicData : public dds::core::Value
    {
    public:
        const dds::topic::BuiltinTopicKey& key() const
        const org::opensplice::core::policy::ProductData&   product() const
    };

    class CMPublisherBuiltinTopicData : public dds::core::Value
    {
    public:
        const dds::topic::BuiltinTopicKey& key() const
        const org::opensplice::core::policy::ProductData& product() const
        const dds::topic::BuiltinTopicKey& participant_key() const
        const std::string& name() const
        const dds::core::policy::EntityFactory& entity_factory() const
        const dds::core::policy::Partition& partition() const
    };

    class CMSubscriberBuiltinTopicData : public dds::core::Value
    {
    public:
        const dds::topic::BuiltinTopicKey& key() const
        const org::opensplice::core::policy::ProductData&   product() const
        const dds::topic::BuiltinTopicKey& participant_key() const
        const std::string& name() const
        const dds::core::policy::EntityFactory& entity_factory() const
        const dds::core::policy::Partition& partition() const
        const org::opensplice::core::policy::Share& share() const
    };

    class CMDataWriterBuiltinTopicData : public dds::core::Value
    {
    public:
        const dds::topic::BuiltinTopicKey& key() const
        const org::opensplice::core::policy::ProductData& product() const
        const dds::topic::BuiltinTopicKey& publisher_key() const
        const std::string& name() const
        const dds::core::policy::History& history() const
        const dds::core::policy::ResourceLimits& resource_limits() const
        const dds::core::policy::WriterDataLifecycle& writer_data_lifecycle() const
    };

    class CMDataReaderBuiltinTopicData : public dds::core::Value
    {
    public:
        const dds::topic::BuiltinTopicKey& key() const
        const org::opensplice::core::policy::ProductData& product() const
        const dds::topic::BuiltinTopicKey& subscriber_key() const
        const std::string& name() const
        const dds::core::policy::History& history() const
        const dds::core::policy::ResourceLimits& resource_limits() const
        const dds::core::policy::ReaderDataLifecycle& reader_data_lifecycle() const
        const org::opensplice::core::policy::SubscriptionKey& subscription_keys() const
        const org::opensplice::core::policy::ReaderLifespan& reader_lifespan() const
        const org::opensplice::core::policy::Share& share() const
    };

namespace qos {

    dds::topic::qos::TopicQos TransientReliable(void);

} /* namespace qos */

} /* namespace topic */




namespace domain {

    uint32_t default_id();

    class DomainParticipantListener :
        public virtual dds::domain::DomainParticipantListener,
        public virtual org::opensplice::topic::AnyTopicListener
    { };

    class NoOpDomainParticipantListener :
        public virtual dds::domain::NoOpDomainParticipantListener,
        public virtual org::opensplice::topic::NoOpAnyTopicListener
    { };

} /* namespace domain */




namespace core {
namespace status {

    class AllDataDisposedTopicStatus : public dds::core::Value
    {
    public:
        int32_t total_count() const
        {
            return this->delegate().total_count();
        }

        int32_t total_count_change() const
        {
            return this->delegate().total_count_change();
        }
    };

} /* namespace status */
} /* namespace core */




namespace core {
namespace policy {
    struct InvalidSampleVisibility
    {
        enum Type
        {
            NO_INVALID_SAMPLES,      
            MINIMUM_INVALID_SAMPLES, 
            ALL_INVALID_SAMPLES      
        };
    };

    struct SchedulingKind
    {
        enum Type
        {
            SCHEDULE_DEFAULT,        
            SCHEDULE_TIMESHARING,    
            SCHEDULE_REALTIME        
        };
    };

    struct SchedulingPriorityKind
    {
        enum Type
        {
            PRIORITY_RELATIVE,       
            PRIORITY_ABSOLUTE        
        };
    };


    class Share : public dds::core::Value
    {
    public:
        Share();

        Share(const std::string& name, bool enable);

        Share(const Share& other);

    public:
        Share& name(const std::string& name);

        std::string name() const;

        Share& enable(bool enable);

        bool enable() const;
    };


    class ProductData : public dds::core::Value
    {
    public:
        ProductData();

        ProductData(const std::string& name);

        ProductData(const ProductData& other);

    public:
        ProductData& name(const std::string& name);

        std::string name() const;
    };

    class SubscriptionKey : public dds::core::Value
    {
    public:
        SubscriptionKey();

        explicit SubscriptionKey(bool use_key_list, const std::string& key);

        explicit SubscriptionKey(bool use_key_list, const dds::core::StringSeq& keys);

        SubscriptionKey(const SubscriptionKey& other);

    public:
        SubscriptionKey& key(const std::string& key);

        SubscriptionKey& key(const dds::core::StringSeq& keys);

        const dds::core::StringSeq key() const;

        SubscriptionKey& use_key_list(bool use_key_list);

        bool use_key_list() const;
    };

    class ReaderLifespan : public dds::core::Value
    {
    public:
        ReaderLifespan();

        explicit ReaderLifespan(bool used, const dds::core::Duration& duration);

        ReaderLifespan(const ReaderLifespan& other);

    public:
        ReaderLifespan& used(bool used);

        bool used() const;

        ReaderLifespan& duration(const dds::core::Duration& duration);

        const dds::core::Duration duration() const;
    };

    class Scheduling : public dds::core::Value
    {
    public:
        Scheduling& scheduling_kind(const org::opensplice::core::policy::SchedulingKind::Type& scheduling_kind);

        org::opensplice::core::policy::SchedulingKind::Type scheduling_kind() const;

        Scheduling& scheduling_kind(const org::opensplice::core::policy::SchedulingPriorityKind::Type& scheduling_priority_kind);

        org::opensplice::core::policy::SchedulingPriorityKind::Type scheduling_priority_kind() const;

        Scheduling& scheduling_priority(int32_t scheduling_priority);

        int32_t scheduling_priority() const;
    };

    class ListenerScheduling : public org::opensplice::core::policy::Scheduling
    {
    public:
        ListenerScheduling();

        explicit ListenerScheduling(const org::opensplice::core::policy::SchedulingKind::Type& scheduling_kind,
                                    const org::opensplice::core::policy::SchedulingPriorityKind::Type& scheduling_priority_kind,
                                    int32_t scheduling_priority);

        ListenerScheduling(const ListenerScheduling& other);
    };

    class WatchdogScheduling : public org::opensplice::core::policy::Scheduling
    {
    public:
        WatchdogScheduling();

        explicit WatchdogScheduling(const org::opensplice::core::policy::SchedulingKind::Type& scheduling_kind,
                                    const org::opensplice::core::policy::SchedulingPriorityKind::Type& scheduling_priority_kind,
                                    int32_t scheduling_priority);

        WatchdogScheduling(const WatchdogScheduling& other);
    };

} /* namespace policy */
} /* namespace core */


} /* namespace opensplice */
} /* namespace org */

#endif /* DOXYGEN_FOR_ISOCPP2 */

#endif /* OMG_DDS_CORE_DETAIL_PROPRIETARY_API_HPP_ */