Program Listing for File RTPSWriter.hpp

↰ Return to documentation for file (include/fastdds/rtps/writer/RTPSWriter.hpp)

// Copyright 2016 Proyectos y Sistemas de Mantenimiento SL (eProsima).
//
// 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 FASTDDS_RTPS_WRITER__RTPSWRITER_HPP
#define FASTDDS_RTPS_WRITER__RTPSWRITER_HPP

#include <chrono>
#include <cstdint>
#include <functional>
#include <limits>
#include <memory>
#include <mutex>
#include <vector>

#include <fastdds/fastdds_dll.hpp>
#include <fastdds/dds/core/policy/QosPolicies.hpp>
#include <fastdds/dds/core/status/BaseStatus.hpp>
#include <fastdds/rtps/attributes/HistoryAttributes.hpp>
#include <fastdds/rtps/attributes/WriterAttributes.hpp>
#include <fastdds/rtps/builtin/data/SubscriptionBuiltinTopicData.hpp>
#include <fastdds/rtps/common/CdrSerialization.hpp>
#include <fastdds/rtps/common/Guid.hpp>
#include <fastdds/rtps/common/RemoteLocators.hpp>
#include <fastdds/rtps/common/VendorId_t.hpp>
#include <fastdds/rtps/Endpoint.hpp>
#include <fastdds/rtps/interfaces/IReaderDataFilter.hpp>
#include <fastdds/statistics/IListeners.hpp>
#include <fastdds/statistics/rtps/monitor_service/connections_fwd.hpp>
#include <fastdds/rtps/common/SequenceNumber.hpp>
#include <fastdds/rtps/common/Time_t.hpp>
#include <fastdds/utils/TimedMutex.hpp>

namespace eprosima {
namespace fastdds {
namespace rtps {

class FlowController;
class RTPSParticipantImpl;
class WriterHistory;
class WriterListener;

class RTPSWriter : public Endpoint
{
protected:

    RTPSWriter(
            RTPSParticipantImpl* impl,
            const GUID_t& guid,
            const WriterAttributes& att);

    virtual ~RTPSWriter();

public:

    FASTDDS_EXPORTED_API virtual bool matched_reader_add(
            const SubscriptionBuiltinTopicData& info) = 0;

    FASTDDS_EXPORTED_API virtual bool matched_reader_remove(
            const GUID_t& reader_guid) = 0;

    FASTDDS_EXPORTED_API virtual bool matched_reader_is_matched(
            const GUID_t& reader_guid) = 0;

    FASTDDS_EXPORTED_API virtual void reader_data_filter(
            IReaderDataFilter* filter) = 0;

    FASTDDS_EXPORTED_API virtual const IReaderDataFilter* reader_data_filter() const = 0;

    FASTDDS_EXPORTED_API virtual bool has_been_fully_delivered(
            const SequenceNumber_t& seq_num) const = 0;

    FASTDDS_EXPORTED_API virtual bool is_acked_by_all(
            const SequenceNumber_t& seq_num) const = 0;

    FASTDDS_EXPORTED_API virtual bool wait_for_all_acked(
            const dds::Duration_t& max_wait) = 0;

    FASTDDS_EXPORTED_API virtual void update_attributes(
            const WriterAttributes& att) = 0;

    FASTDDS_EXPORTED_API virtual WriterListener* get_listener() const = 0;

    FASTDDS_EXPORTED_API virtual bool set_listener(
            WriterListener* listener) = 0;

    FASTDDS_EXPORTED_API virtual bool is_async() const = 0;

    FASTDDS_EXPORTED_API virtual bool get_disable_positive_acks() const = 0;

#ifdef FASTDDS_STATISTICS

    FASTDDS_EXPORTED_API virtual bool add_statistics_listener(
            std::shared_ptr<fastdds::statistics::IListener> listener) = 0;

    FASTDDS_EXPORTED_API virtual bool remove_statistics_listener(
            std::shared_ptr<fastdds::statistics::IListener> listener) = 0;

    FASTDDS_EXPORTED_API virtual void set_enabled_statistics_writers_mask(
            uint32_t enabled_writers) = 0;

    FASTDDS_EXPORTED_API virtual bool get_connections(
            fastdds::statistics::rtps::ConnectionList& connection_list) = 0;

#endif // FASTDDS_STATISTICS

private:

    RTPSWriter& operator =(
            const RTPSWriter&) = delete;

};

} // namespace rtps
} // namespace fastdds
} // namespace eprosima

#endif // FASTDDS_RTPS_WRITER__RTPSWRITER_HPP