libcommonc++  0.7
MemoryMappedFile.h++
Go to the documentation of this file.
1 /* ---------------------------------------------------------------------------
2  commonc++ - A C++ Common Class Library
3  Copyright (C) 2005-2014 Mark A Lindner
4 
5  This file is part of commonc++.
6 
7  This library is free software; you can redistribute it and/or
8  modify it under the terms of the GNU Library General Public
9  License as published by the Free Software Foundation; either
10  version 2 of the License, or (at your option) any later version.
11 
12  This library is distributed in the hope that it will be useful,
13  but WITHOUT ANY WARRANTY; without even the implied warranty of
14  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15  Library General Public License for more details.
16 
17  You should have received a copy of the GNU Library General Public
18  License along with this library; if not, write to the Free
19  Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20  ---------------------------------------------------------------------------
21 */
22 
23 #ifndef __ccxx_MemoryMappedFile_hxx
24 #define __ccxx_MemoryMappedFile_hxx
25 
26 #include <commonc++/Common.h++>
29 
30 namespace ccxx {
31 
38 {
39  public:
40 
46  MemoryMappedFile(const String& path);
47 
50 
65  void open(uint64_t size = 0, bool readOnly = false);
66 
68  void close();
69 
77  void sync(bool async = false);
78 
80  inline byte_t* getBase()
81  { return(_base); }
82 
84  inline const byte_t* getBase() const
85  { return(_base); }
86 
88  inline uint64_t getSize() const
89  { return(_size); }
90 
91  private:
92 
93  String _path;
94  FileHandle _handle;
95 #ifdef CCXX_OS_WINDOWS
96  HANDLE _memHandle;
97 #endif
98  byte_t* _base;
99  uint64_t _size;
100  bool _open;
101 };
102 
103 } // namespace ccxx
104 
105 #endif // __ccxx_MemoryMappedFile_hxx
const byte_t * getBase() const
Get a pointer to the base of the mapped memory segment.
Definition: MemoryMappedFile.h++:84
int FileHandle
Definition: Common.h++:225
byte_t * getBase()
Get a pointer to the base of the mapped memory segment.
Definition: MemoryMappedFile.h++:80
An abstraction of a memory-mapped file.
Definition: MemoryMappedFile.h++:37
#define COMMONCPP_API
Definition: Common.h++:126
A flexible, reference counted, copy-on-write, thread-safe, nullable string.
Definition: String.h++:50
uint64_t getSize() const
Get the size of the memory mapped segment, in bytes.
Definition: MemoryMappedFile.h++:88
Definition: AllocationMap.c++:25
unsigned char byte_t
An unsigned 8-bit value.
Definition: Integers.h++:68