![]() |
Home | Libraries | People | FAQ | More |
boost::interprocess::windows_shared_memory
// In header: <boost/interprocess/windows_shared_memory.hpp> class windows_shared_memory { public: // construct/copy/destruct () ; (create_only_t, , , , permissions & = permissions()); (open_or_create_t, , , , permissions & = permissions()); (open_only_t, , ); (create_only_t, , , , permissions & = permissions()); (open_or_create_t, , , , permissions & = permissions()); (open_only_t, , ); (windows_shared_memory &&) ; windows_shared_memory & (windows_shared_memory &&) ; ~(); // public member functions (windows_shared_memory &) ; () ; () ; () ; () ; };
A class that wraps the native Windows shared memory that is implemented as a file mapping of the paging file. Unlike shared_memory_object, windows_shared_memory has no kernel persistence and the shared memory is destroyed when all processes destroy all their windows_shared_memory objects and mapped regions for the same shared memory or the processes end/crash.
Warning: Windows native shared memory and interprocess portable shared memory (boost::interprocess::shared_memory_object) can't communicate between them.
windows_shared_memory
public
construct/copy/destruct() ;
Default constructor. Represents an empty windows_shared_memory
.
(create_only_t, name, mode, size, permissions & perm = permissions());
Creates a new native shared memory with name "name" and at least size "size", with the access mode "mode". If the file previously exists, throws an error.
(open_or_create_t, name, mode, size, permissions & perm = permissions());
Tries to create a shared memory object with name "name" and at least size "size", with the access mode "mode". If the file previously exists, it tries to open it with mode "mode". Otherwise throws an error.
(open_only_t, name, mode);
Tries to open a shared memory object with name "name", with the access mode "mode". If the file does not previously exist, it throws an error.
(create_only_t, name, mode, size, permissions & perm = permissions());
Creates a new native shared memory with name "name" and at least size "size", with the access mode "mode". If the file previously exists, throws an error.
(open_or_create_t, name, mode, size, permissions & perm = permissions());
Tries to create a shared memory object with name "name" and at least size "size", with the access mode "mode". If the file previously exists, it tries to open it with mode "mode". Otherwise throws an error.
(open_only_t, name, mode);
Tries to open a shared memory object with name "name", with the access mode "mode". If the file does not previously exist, it throws an error.
(windows_shared_memory && moved) ;
Moves the ownership of "moved"'s shared memory object to *this. After the call, "moved" does not represent any shared memory object. Does not throw
windows_shared_memory & (windows_shared_memory && moved) ;
Moves the ownership of "moved"'s shared memory to *this. After the call, "moved" does not represent any shared memory. Does not throw
~();
Destroys *this. All mapped regions are still valid after destruction. When all mapped regions and windows_shared_memory
objects referring the shared memory are destroyed, the operating system will destroy the shared memory.
windows_shared_memory
public member functions(windows_shared_memory & other) ;Swaps to shared_memory_objects. Does not throw.
() ;Returns the name of the shared memory.
() ;Returns access mode.
() ;Returns the mapping handle. Never throws.
() ;
Returns the size of the windows shared memory. It will be a 4K rounded size of the "size" passed in the constructor.