https://github.com/codylico/mmaptwo-plus
Memory mapping files on POSIX and Windows for C++ 2011
https://github.com/codylico/mmaptwo-plus
cmake cpp11 memory-mapped memory-mapped-file mmap posix unix unlicense win32api
Last synced: 8 months ago
JSON representation
Memory mapping files on POSIX and Windows for C++ 2011
- Host: GitHub
- URL: https://github.com/codylico/mmaptwo-plus
- Owner: codylico
- License: unlicense
- Created: 2019-11-30T02:14:05.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-09-20T00:27:13.000Z (over 1 year ago)
- Last Synced: 2025-07-11T07:24:54.983Z (11 months ago)
- Topics: cmake, cpp11, memory-mapped, memory-mapped-file, mmap, posix, unix, unlicense, win32api
- Language: C++
- Homepage:
- Size: 55.7 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# mmaptwo-plus
The `mmaptwo-plus` library aims to provide an API for interacting with files
through mapping to memory.
## Goals
This project aims to provide easy-to-use access to the memory mapping on
Unix and Windows. The target API language is C++ 2011. In addition:
- The API should provide a base interface for file accesses.
- The interface should be simple and orthogonal.
- The interface should allow for mapping a file multiple times
without needing to close the file between each mapping.
- The source should not use more language features or libraries
than necessary, and should not be larger (in lines of code)
than needed.
- The library should throw exceptions where appropriate, without
causing an application to terminate without recourse.
## Build
This project uses CMake for building. Developers can obtain CMake from
the following URL:
[https://cmake.org/download/](https://cmake.org/download/)
To use CMake with this project, first make a directory to hold the build
results. Then run CMake in the directory with a path to the source code.
On UNIX, the commands would look like the following:
```
mkdir build
cd build
cmake ../mmaptwo-plus
```
Running CMake should create a build project, which then can be processed
using other tools. Usually, the tool would be Makefile or a IDE project.
For Makefiles, use the following command to build the project:
```
make
```
For IDE projects, the IDE must be installed and ready to use. Open the
project within the IDE.
Since this project's source only holds two files, developers could also
use these files independently from CMake.
## License
This project uses the Unlicense, which makes the source effectively
public domain. Go to [http://unlicense.org/](http://unlicense.org/)
to learn more about the Unlicense.
Contributions to this project should likewise be provided under a
public domain dedication.