MemoryMappedFile.h

#pragma once
 
#include <Foundation/Types/UniquePtr.h>
 
struct plMemoryMappedFileImpl;
 
class PL_FOUNDATION_DLL plMemoryMappedFile
{
  PL_DISALLOW_COPY_AND_ASSIGN(plMemoryMappedFile);
 
public:
  plMemoryMappedFile();
  ~plMemoryMappedFile();
 
  enum class Mode
  {
    None,      
    ReadOnly,  
    ReadWrite, 
  };
 
  enum class OffsetBase
  {
    Start, 
    End,   
  };
 
#if PL_ENABLED(PL_SUPPORTS_MEMORY_MAPPED_FILE) || defined(PL_DOCS)
  plResult Open(plStringView sAbsolutePath, Mode mode);
#endif
 
#if PL_ENABLED(PL_SUPPORTS_SHARED_MEMORY) || defined(PL_DOCS)
  plResult OpenShared(plStringView sSharedName, plUInt64 uiSize, Mode mode);
#endif
 
  void Close();
 
  Mode GetMode() const;
 
  plUInt64 GetFileSize() const;
 
  const void* GetReadPointer(plUInt64 uiOffset = 0, OffsetBase base = OffsetBase::Start) const;
 
  void* GetWritePointer(plUInt64 uiOffset = 0, OffsetBase base = OffsetBase::Start);
 
private:
  plUniquePtr<plMemoryMappedFileImpl> m_pImpl;
};