src/hpp/tdds/sub/Subscriber.hpp

Go to the documentation of this file.

#ifndef OMG_TDDS_SUB_SUBSCRIBER_HPP_
#define OMG_TDDS_SUB_SUBSCRIBER_HPP_

/* Copyright 2010, Object Management Group, Inc.
 * Copyright 2010, PrismTech, Corp.
 * Copyright 2010, Real-Time Innovations, Inc.
 * 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.
 */

#include <dds/core/corefwd.hpp>
#include <tdds/core/Entity.hpp>
#include <dds/core/cond/StatusCondition.hpp>
#include <dds/topic/topicfwd.hpp>
#include <dds/sub/subfwd.hpp>
#include <dds/sub/qos/SubscriberQos.hpp>


namespace tdds { namespace sub {

template <typename DELEGATE>
class Subscriber : public tdds::core::Entity<DELEGATE> {
public:
        OMG_DDS_REF_TYPE(Subscriber, tdds::core::Entity, DELEGATE)

public:
    typedef dds::sub::SubscriberListener                 Listener;
    typedef dds::core::cond::StatusCondition<Subscriber> StatusCondition;

public:
        ~Subscriber() {}
public:
    StatusCondition status_condition() const{
        return this->delegate()->template status_condition<Subscriber>(*this);
    }

public:
        void notify_datareaders() {
                this->delegate()->notify_datareaders();
        }

    void listener(Listener*,
                  const dds::core::status::StatusMask& event_mask);

    Listener* listener() const;

    using tdds::core::Entity<DELEGATE>::qos;

        const dds::sub::qos::SubscriberQos qos() const {
                return this->delegate()->qos();
        }

        void qos(const dds::sub::qos::SubscriberQos& the_qos) {
                this->delegate()->qos(the_qos);
        }

    // --- DataReader Factory Methods: --- //
public:
    template <typename T>
    dds::sub::DataReader<T> create_datareader(
            const dds::topic::TopicDescription<T>&  a_topic);

    template <typename T>
    dds::sub::DataReader<T> create_datareader(
            const dds::topic::TopicDescription<T>&  a_topic,
            const dds::sub::qos::DataReaderQos&     a_qos,
            dds::sub::DataReaderListener<T>*        a_listener = NULL,
            const dds::core::status::StatusMask&    a_mask     =
                    dds::core::status::StatusMask::all());

    template <typename T>
    dds::sub::DataReader<T> create_datareader(
            const dds::topic::TopicDescription<T>&  a_topic,
            const std::string&                      qos_library_name,
            const std::string&                      qos_profile_name,
            dds::sub::DataReaderListener<T>*        a_listener = NULL,
            const dds::core::status::StatusMask&    a_mask     =
                    dds::core::status::StatusMask::all());

    const dds::sub::qos::DataReaderQos default_datareader_qos() const;
    void default_datareader_qos(const dds::sub::qos::DataReaderQos &qos);
    void default_datareader_qos(const std::string& qos_library_name,
                                const std::string& qos_profile_name);
};

}}
#endif /* OMG_TDDS_SUB_SUBSCRIBER_HPP_ */