WriterHistory.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_HISTORY__WRITERHISTORY_HPP
#define FASTDDS_RTPS_HISTORY__WRITERHISTORY_HPP
 
#include <cstdint>
#include <memory>
 
#include <fastdds/fastdds_dll.hpp>
#include <fastdds/dds/log/Log.hpp>
#include <fastdds/rtps/common/CacheChange.hpp>
#include <fastdds/rtps/common/ChangeKind_t.hpp>
#include <fastdds/rtps/common/InstanceHandle.hpp>
#include <fastdds/rtps/history/History.hpp>
#include <fastdds/rtps/history/IChangePool.hpp>
#include <fastdds/rtps/history/IPayloadPool.hpp>
 
namespace eprosima {
namespace fastdds {
namespace rtps {
 
class BaseWriter;
class HistoryAttributes;
class WriteParams;
 
class WriterHistory : public rtps::History
{
    friend class BaseWriter;
    friend class PersistentWriter;
    friend class IPersistenceService;
 
    WriterHistory(
            WriterHistory&&) = delete;
    WriterHistory& operator =(
            WriterHistory&&) = delete;
 
public:
 
    FASTDDS_EXPORTED_API WriterHistory(
            const HistoryAttributes& att);
 
    FASTDDS_EXPORTED_API WriterHistory(
            const HistoryAttributes& att,
            const std::shared_ptr<IPayloadPool>& payload_pool);
 
    FASTDDS_EXPORTED_API WriterHistory(
            const HistoryAttributes& att,
            const std::shared_ptr<IPayloadPool>& payload_pool,
            const std::shared_ptr<IChangePool>& change_pool);
 
    FASTDDS_EXPORTED_API virtual ~WriterHistory() override;
 
    FASTDDS_EXPORTED_API const std::shared_ptr<IPayloadPool>& get_payload_pool() const;
 
    FASTDDS_EXPORTED_API const std::shared_ptr<IChangePool>& get_change_pool() const;
 
    FASTDDS_EXPORTED_API CacheChange_t* create_change(
            ChangeKind_t change_kind,
            InstanceHandle_t handle = c_InstanceHandle_Unknown);
 
    FASTDDS_EXPORTED_API CacheChange_t* create_change(
            uint32_t payload_size,
            ChangeKind_t change_kind,
            InstanceHandle_t handle = c_InstanceHandle_Unknown);
 
    FASTDDS_EXPORTED_API bool add_change(
            CacheChange_t* a_change);
 
    FASTDDS_EXPORTED_API bool add_change(
            CacheChange_t* a_change,
            WriteParams& wparams);
 
    FASTDDS_EXPORTED_API iterator remove_change_nts(
            const_iterator removal,
            bool release = true) override;
 
    FASTDDS_EXPORTED_API iterator remove_change_nts(
            const_iterator removal,
            const std::chrono::time_point<std::chrono::steady_clock>& max_blocking_time,
            bool release = true) override;
 
    FASTDDS_EXPORTED_API bool matches_change(
            const CacheChange_t* inner,
            CacheChange_t* outer) override;
 
    using History::remove_change;
 
    FASTDDS_EXPORTED_API virtual bool remove_change_g(
            CacheChange_t* a_change);
 
    FASTDDS_EXPORTED_API virtual bool remove_change_g(
            CacheChange_t* a_change,
            const std::chrono::time_point<std::chrono::steady_clock>& max_blocking_time);
 
    FASTDDS_EXPORTED_API bool remove_change(
            const SequenceNumber_t& sequence_number);
 
    FASTDDS_EXPORTED_API CacheChange_t* remove_change_and_reuse(
            const SequenceNumber_t& sequence_number);
 
    FASTDDS_EXPORTED_API bool remove_min_change();
 
    FASTDDS_EXPORTED_API bool remove_min_change(
            const std::chrono::time_point<std::chrono::steady_clock>& max_blocking_time);
 
    FASTDDS_EXPORTED_API SequenceNumber_t next_sequence_number() const
    {
        return m_lastCacheChangeSeqNum + 1;
    }
 
    FASTDDS_EXPORTED_API bool release_change(
            CacheChange_t* ch);
 
protected:
 
    FASTDDS_EXPORTED_API void do_release_cache(
            CacheChange_t* ch) override;
 
    bool add_change_(
            CacheChange_t* a_change,
            WriteParams& wparams,
            std::chrono::time_point<std::chrono::steady_clock> max_blocking_time
            = std::chrono::steady_clock::now() + std::chrono::hours(24));
 
    template<typename PreCommitHook>
    bool add_change_with_commit_hook(
            CacheChange_t* a_change,
            WriteParams& wparams,
            PreCommitHook pre_commit,
            std::chrono::time_point<std::chrono::steady_clock> max_blocking_time)
    {
        if (mp_writer == nullptr || mp_mutex == nullptr)
        {
            EPROSIMA_LOG_ERROR(RTPS_WRITER_HISTORY,
                    "You need to create a Writer with this History before adding any changes");
            return false;
        }
 
        std::lock_guard<RecursiveTimedMutex> guard(*mp_mutex);
        if (!prepare_and_add_change(a_change, wparams))
        {
            return false;
        }
 
        pre_commit(*a_change);
        notify_writer(a_change, max_blocking_time);
 
        return true;
    }
 
    SequenceNumber_t m_lastCacheChangeSeqNum {};
    BaseWriter* mp_writer = nullptr;
 
    uint32_t high_mark_for_frag_ = 0;
 
private:
 
    bool prepare_and_add_change(
            CacheChange_t* a_change,
            WriteParams& wparams);
 
    void notify_writer(
            CacheChange_t* a_change,
            const std::chrono::time_point<std::chrono::steady_clock>& max_blocking_time);
 
    void set_fragments(
            CacheChange_t* change);
 
    std::shared_ptr<IChangePool> change_pool_;
    std::shared_ptr<IPayloadPool> payload_pool_;
};
 
} // namespace rtps
} // namespace fastdds
} // namespace eprosima
 
#endif // FASTDDS_RTPS_HISTORY__WRITERHISTORY_HPP