coffee/mio
1
0
Fork 0
mirror of https://github.com/vimpunk/mio.git synced 2026-10-28 18:07:20 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update docs, example.cpp and README.md

Browse Source
This commit is contained in:
mandreyel 2018-10-22 18:42:56 +02:00
parent 865d7f35ce
commit 1157537c98
4 changed files with 19 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -113,14 +113,15 @@ int main()
const int answer_index = rw_mmap.size() / 2; const int answer_index = rw_mmap.size() / 2;
rw_mmap[answer_index] = 42; rw_mmap[answer_index] = 42;
// Don't forget to flush changes to disk, which is NOT done by the destructor for // Don't forget to flush changes to disk before unmapping. However, if
// more explicit control of this potentially expensive operation. // `rw_mmap` were to go out of scope at this point, the destructor would also
// automatically invoke `sync` before `unmap`.
rw_mmap.sync(error); rw_mmap.sync(error);
if (error) { return handle_error(error); } if (error) { return handle_error(error); }
// We can then remove the mapping, after which rw_mmap will be in a default // We can then remove the mapping, after which rw_mmap will be in a default
// constructed state, i.e. this has the same effect as if the destructor had been // constructed state, i.e. this and the above call to `sync` have the same
// invoked. // effect as if the destructor had been invoked.
rw_mmap.unmap(); rw_mmap.unmap();
// Now create the same mapping, but in read-only mode. // Now create the same mapping, but in read-only mode.

5
include/mio/mmap.hpp
View File

@ -135,7 +135,10 @@ public:
basic_mmap& operator=(const basic_mmap&) = delete; basic_mmap& operator=(const basic_mmap&) = delete;
basic_mmap& operator=(basic_mmap&&); basic_mmap& operator=(basic_mmap&&);
/** The destructor invokes unmap. */ /**
* If this is a read-write mapping, the destructor invokes sync. Regardless
* of the access mode, unmap is invoked as a final step.
*/
~basic_mmap(); ~basic_mmap();
/** /**

5
include/mio/shared_mmap.hpp
View File

@ -110,6 +110,11 @@ public:
if(error) { throw error; } if(error) { throw error; }
} }
/**
* If this is a read-write mapping and the last reference to the mapping,
* the destructor invokes sync. Regardless of the access mode, unmap is
* invoked as a final step.
*/
~basic_shared_mmap() = default; ~basic_shared_mmap() = default;
/** Returns the underlying `std::shared_ptr` instance that holds the mmap. */ /** Returns the underlying `std::shared_ptr` instance that holds the mmap. */

9
test/example.cpp
View File

@ -49,14 +49,15 @@ int main()
const int answer_index = rw_mmap.size() / 2; const int answer_index = rw_mmap.size() / 2;
rw_mmap[answer_index] = 42; rw_mmap[answer_index] = 42;
// Don't forget to flush changes to disk, which is NOT done by the destructor for // Don't forget to flush changes to disk before unmapping. However, if
// more explicit control of this potentially expensive operation. // `rw_mmap` were to go out of scope at this point, the destructor would also
// automatically invoke `sync` before `unmap`.
rw_mmap.sync(error); rw_mmap.sync(error);
if (error) { return handle_error(error); } if (error) { return handle_error(error); }
// We can then remove the mapping, after which rw_mmap will be in a default // We can then remove the mapping, after which rw_mmap will be in a default
// constructed state, i.e. this has the same effect as if the destructor had been // constructed state, i.e. this and the above call to `sync` have the same
// invoked. // effect as if the destructor had been invoked.
rw_mmap.unmap(); rw_mmap.unmap();
// Now create the same mapping, but in read-only mode. // Now create the same mapping, but in read-only mode.