sharedmemory.h

Go to the documentation of this file.

 
#pragma once
 
 
#include <promeki/config.h>
#if PROMEKI_ENABLE_CORE
#include <cstdint>
#include <cstddef>
#include <promeki/namespace.h>
#include <promeki/string.h>
#include <promeki/error.h>
 
PROMEKI_NAMESPACE_BEGIN
 
class SharedMemory {
        public:
                static constexpr uint32_t DefaultPermissions = 0600;
 
                enum Access {
                        ReadOnly, 
                        ReadWrite 
                };
 
                static bool isSupported();
 
                static Error unlink(const String &name);
 
                SharedMemory();
 
                ~SharedMemory();
 
                SharedMemory(const SharedMemory &) = delete;
                SharedMemory &operator=(const SharedMemory &) = delete;
 
                SharedMemory(SharedMemory &&other) noexcept;
 
                SharedMemory &operator=(SharedMemory &&other) noexcept;
 
                Error create(const String &name, size_t size, uint32_t mode = DefaultPermissions,
                             const String &groupName = String());
 
                Error open(const String &name, Access access = ReadOnly);
 
                void close();
 
                bool isValid() const { return _data != nullptr; }
 
                bool isOwner() const { return _owner; }
 
                void *data() { return _data; }
 
                const void *data() const { return _data; }
 
                size_t size() const { return _size; }
 
                const String &name() const { return _name; }
 
                Access access() const { return _access; }
 
        private:
                String   _name;
                void    *_data = nullptr;
                size_t   _size = 0;
                intptr_t _handle = -1; // fd (POSIX) or HANDLE (Windows)
                bool     _owner = false;
                Access   _access = ReadOnly;
};
 
PROMEKI_NAMESPACE_END
 
#endif // PROMEKI_ENABLE_CORE