lgrLegacyCheckpointedFormat.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 1992-2025 MAK Technologies, Inc
** All rights reserved.
******************************************************************************/


#ifndef lgrLegacyCheckpointedFormat_H_
#define lgrLegacyCheckpointedFormat_H_

#include <lgrCore/lgrLegacyUncheckpointedFormat.h>
#include <vlutil/vlNetTypes.h>

namespace MAKLogger
{

   class DtLgrPacketIndexer;

   class DT_DLL_LGRCORE DtLgrLegacyCheckpointedFormat : public DtLgrLegacyUncheckpointedFormat
   {
   protected:
      DtLgrLegacyCheckpointedFormat(DtLoggerFile*);
   public:
      virtual ~DtLgrLegacyCheckpointedFormat();

   private:
      DtLgrLegacyCheckpointedFormat(const DtLgrLegacyCheckpointedFormat&);
      DtLgrLegacyCheckpointedFormat& operator=(const DtLgrLegacyCheckpointedFormat&);
   public:

      const static DtNetU32 theEOFMagic;

      virtual void initializeSerialMode(DtFilePosition firstPacket = 0,
         DtFilePosition lastPacket = 0, bool skipCheckpointRead=false);

      virtual void copyMetaData(const DtLgrFileFormatter* formatter);

      virtual bool seekToFirstPacket(int type);

      virtual bool seekToLastPacket(int type);

      virtual bool seekToFirstPacketBeforeTime(int type,double time);

      virtual bool seekToFirstPacketAfterTime(int type,double time);


      using DtLgrLegacyUncheckpointedFormat::seekToNextPacket;
      virtual bool seekToNextPacket(int type);

      virtual bool seekToPreviousPacketOfType(int type);

      virtual void writePacket(const DtPacket& packet);

      virtual size_t writePacket(const DtPacket& packet,void* memory,size_t memorySize,
         int fileWriteBufferOffset = -1);

      virtual bool hasCheckpoints() const;

      virtual bool isEofValid() const;

      virtual double duration() const;

      virtual void setDuration(double duration);

   protected:

      virtual void initReadEndMetaData();

      virtual void readRecordingInfoMetaData();

      virtual void decodeRecordingInfoPacket(const DtPacket& packet);

      virtual void writeRecordingData();

      virtual void readIndexTableMetaData();

      virtual void writeIndexTable();

      virtual bool checkEofMagic();

      virtual void writeEofMagic();

      virtual bool jumpToIndex(int index);

      virtual DtPacket* encodePacket(DtPacket::DtPacketType type);

      virtual void decodePacket(DtPacket* packet);

      virtual void indexCheckpoint(double time, DtFilePosition position, int size);

      virtual void linkCheckpoint(const DtPacket& packet);

      virtual void linkCheckpoint(const DtPacket& packet, void* memory, int fileWriteBufferOffset);

      virtual bool refreshCheckpoints(double time);

      virtual bool readCheckpointsToTime(double time);

      virtual DtLgrPacketIndexer* packetIndexer();
      virtual const DtLgrPacketIndexer* packetIndexer() const;

   protected:

      DtLgrPacketIndexer* myPacketIndexer;
      double myDuration;
      bool myEofMagicIsValid;
      bool myEofMagicIsSet;
      DtFilePosition myRecordingInfoPosition;
      DtFilePosition myIndexTablePosition;
      DtFilePosition myDescriptionDataPosition;
      bool myLinkedCheckpoints;
      bool myDisableIndexer;
      DtFilePosition myCheckpointSearchEndPosition;
      double myCheckpointSearchEndTime;
   };
}

#endif