StorageStreamReader.hpp

/*
 * (c) Copyright, Real-Time Innovations, 2017-.
 * All rights reserved.
 * No duplications, whole or partial, manual or electronic, may be made
 * without express written permission.  Any such copies, or
 * revisions thereof, must display this notice unaltered.
 * This code contains trade secrets of Real-Time Innovations, Inc.
 *
 */

#ifndef HPP_RTI_RECORDING_STORAGE_STREAMREADER_HPP_
#define HPP_RTI_RECORDING_STORAGE_STREAMREADER_HPP_

#include <vector>

#include "dds/dds.hpp"

#include "rti/routing/detail/ForwarderUtils.hpp"

#include "rti/recording/storage/SelectorState.hpp"


namespace rti { namespace recording { namespace storage {

class StorageStreamReader {
public:
    
    typedef void* SamplePtr;
    typedef void* InfoPtr;

    virtual ~StorageStreamReader() 
    {
    }

    virtual void read(
            std::vector<SamplePtr>& sample_seq,
            std::vector<InfoPtr>& info_seq,
            const SelectorState& selector) = 0;
    virtual void return_loan(
            std::vector<SamplePtr>& sample_seq,
            std::vector<InfoPtr>& info_seq) = 0;

    virtual bool finished() = 0;

    virtual void reset() = 0;
};

template <typename Data, typename Info>
class TStorageStreamReader : public StorageStreamReader {
public:

   typedef Data DataRep;
   typedef Info InfoRep;

   using StorageStreamReader::read;
   using StorageStreamReader::return_loan;

   void read(
           std::vector<SamplePtr>& sample_seq,
           std::vector<InfoPtr>& info_seq,
           const SelectorState& selector) RTI_FINAL
   {
       read(sample_seq_, info_seq_, selector);
       RTI_ROUTING_SAMPLE_VECTOR_COPY_PTRS(sample_seq, sample_seq_);
       RTI_ROUTING_SAMPLE_VECTOR_COPY_PTRS(info_seq, info_seq_);
   }

   void return_loan(
           std::vector<SamplePtr>& sample_seq,
           std::vector<InfoPtr>& info_seq) RTI_FINAL
   {
       RTI_ROUTING_SAMPLE_VECTOR_COPY_PTRS(sample_seq_, sample_seq);
       RTI_ROUTING_SAMPLE_VECTOR_COPY_PTRS(info_seq_, info_seq);
       return_loan(sample_seq_, info_seq_);
       sample_seq_.clear();
       info_seq_.clear();
   }

   virtual void read(
           std::vector<Data *>& sample_seq,
           std::vector<Info *>& info_seq,
           const SelectorState& selector) = 0;

   virtual void return_loan(
           std::vector<Data *>& sample_seq,
           std::vector<Info *>& info_seq) = 0;

   /*
    * @brief Virtual destructor
    */
   virtual ~TStorageStreamReader() {}

private:

   std::vector<Data*> sample_seq_;
   std::vector<Info*> info_seq_;
};

typedef TStorageStreamReader<
        dds::core::xtypes::DynamicData,
        dds::sub::SampleInfo> DynamicDataStorageStreamReader;

} } } // namespace rti::recording::storage

#endif /* HPP_RTI_RECORDING_STORAGE_STREAMREADER_HPP_ */