MemoryMappedFile.h++

Go to the documentation of this file.

/* ---------------------------------------------------------------------------
   commonc++ - A C++ Common Class Library
   Copyright (C) 2005-2012  Mark A Lindner

   This file is part of commonc++.

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.

   This library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public
   License along with this library; if not, write to the Free
   Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
   ---------------------------------------------------------------------------
*/

#ifndef __ccxx_MemoryMappedFile_hxx
#define __ccxx_MemoryMappedFile_hxx

#include <commonc++/Common.h++>
#include <commonc++/IOException.h++>
#include <commonc++/Permissions.h++>

namespace ccxx {

class COMMONCPP_API MemoryMappedFile
{
  public:

  MemoryMappedFile(const String &path);

  ~MemoryMappedFile() throw();

  void open(uint64_t size = 0, bool readOnly = false) throw(IOException);

  void close() throw();

  void sync(bool async = false) throw(IOException);

  inline byte_t *getBase() throw()
  { return(_base); }

  inline const byte_t *getBase() const throw()
  { return(_base); }

  inline uint64_t getSize() const throw()
  { return(_size); }

  private:

  String _path;
  FileHandle _handle;
#ifdef CCXX_OS_WINDOWS
  HANDLE _memHandle;
#endif
  byte_t *_base;
  uint64_t _size;
  bool _open;
};

}; // namespace ccxx

#endif // __ccxx_MemoryMappedFile_hxx

/* end of header file */