History.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__HISTORY_HPP
#define FASTDDS_RTPS_HISTORY__HISTORY_HPP
 
#include <fastdds/fastdds_dll.hpp>
#include <fastdds/rtps/history/IChangePool.hpp>
#include <fastdds/rtps/history/IPayloadPool.hpp>
#include <fastdds/rtps/common/SequenceNumber.hpp>
#include <fastdds/rtps/common/Guid.hpp>
#include <fastdds/rtps/attributes/HistoryAttributes.hpp>
#include <fastdds/utils/TimedMutex.hpp>
 
#include <cassert>
#include <functional>
#include <memory>
#include <mutex>
 
namespace eprosima {
namespace fastdds {
namespace rtps {
 
class History
{
protected:
 
    History(
            const HistoryAttributes& att);
    History(
            History&&) = delete;
    History& operator =(
            History&&) = delete;
    virtual ~History();
 
public:
 
    using iterator = std::vector<CacheChange_t*>::iterator;
    using reverse_iterator = std::vector<CacheChange_t*>::reverse_iterator;
    using const_iterator = std::vector<CacheChange_t*>::const_iterator;
 
    HistoryAttributes m_att;
 
    FASTDDS_EXPORTED_API bool isFull()
    {
        return m_isHistoryFull;
    }
 
    FASTDDS_EXPORTED_API size_t getHistorySize()
    {
        std::lock_guard<RecursiveTimedMutex> guard(*mp_mutex);
        return m_changes.size();
    }
 
    FASTDDS_EXPORTED_API const_iterator find_change_nts(
            CacheChange_t* ch);
 
    FASTDDS_EXPORTED_API virtual iterator remove_change_nts(
            const_iterator removal,
            bool release = true);
 
    FASTDDS_EXPORTED_API virtual iterator remove_change_nts(
            const_iterator removal,
            const std::chrono::time_point<std::chrono::steady_clock>& max_blocking_time,
            bool release = true);
 
    FASTDDS_EXPORTED_API bool remove_all_changes();
 
    FASTDDS_EXPORTED_API bool remove_change(
            CacheChange_t* ch);
 
    FASTDDS_EXPORTED_API bool remove_change(
            CacheChange_t* ch,
            const std::chrono::time_point<std::chrono::steady_clock>& max_blocking_time);
 
    FASTDDS_EXPORTED_API const_iterator find_change(
            CacheChange_t* ch)
    {
        std::lock_guard<RecursiveTimedMutex> guard(*mp_mutex);
        return find_change_nts(ch);
    }
 
    FASTDDS_EXPORTED_API virtual bool matches_change(
            const CacheChange_t* ch_inner,
            CacheChange_t* ch_outer);
 
    FASTDDS_EXPORTED_API iterator remove_change(
            const_iterator removal,
            bool release = true)
    {
        std::lock_guard<RecursiveTimedMutex> guard(*mp_mutex);
        return remove_change_nts(removal, release);
    }
 
    FASTDDS_EXPORTED_API iterator changesBegin()
    {
        return m_changes.begin();
    }
 
    FASTDDS_EXPORTED_API reverse_iterator changesRbegin()
    {
        return m_changes.rbegin();
    }
 
    FASTDDS_EXPORTED_API iterator changesEnd()
    {
        return m_changes.end();
    }
 
    FASTDDS_EXPORTED_API reverse_iterator changesRend()
    {
        return m_changes.rend();
    }
 
    FASTDDS_EXPORTED_API bool get_min_change(
            CacheChange_t** min_change);
 
    FASTDDS_EXPORTED_API bool get_max_change(
            CacheChange_t** max_change);
 
    FASTDDS_EXPORTED_API inline uint32_t getTypeMaxSerialized()
    {
        return m_att.payloadMaxSize;
    }
 
    FASTDDS_EXPORTED_API inline RecursiveTimedMutex* getMutex() const
    {
        assert(mp_mutex != nullptr);
        return mp_mutex;
    }
 
    FASTDDS_EXPORTED_API bool get_change(
            const SequenceNumber_t& seq,
            const GUID_t& guid,
            CacheChange_t** change) const;
 
    const_iterator get_change_nts(
            const SequenceNumber_t& seq,
            const GUID_t& guid,
            CacheChange_t** change,
            const_iterator hint) const;
 
    bool get_earliest_change(
            CacheChange_t** change);
 
protected:
 
    std::vector<CacheChange_t*> m_changes;
 
    bool m_isHistoryFull = false;
 
    RecursiveTimedMutex* mp_mutex = nullptr;
 
    void print_changes_seqNum2();
 
    FASTDDS_EXPORTED_API virtual void do_release_cache(
            CacheChange_t* ch) = 0;
 
    History::iterator remove_iterator_constness(
            const_iterator c_it);
 
};
 
} // namespace rtps
} // namespace fastdds
} // namespace eprosima
 
#endif // FASTDDS_RTPS_HISTORY__HISTORY_HPP