3#include "Arp/System/Core/TypeName.hxx"
4#include "Arp/System/Core/AppDomainSingleton.hxx"
5#include "Arp/System/Commons/Logging.h"
6#include "Arp/System/Commons/Threading/Thread.hpp"
7#include "boost/interprocess/managed_shared_memory.hpp"
12namespace Arp {
namespace System {
namespace Commons {
namespace Ipc
20 typedef boost::interprocess::managed_shared_memory SharedMemoryImpl;
21 typedef SharedMemoryImpl::segment_manager SegmentManager;
22 typedef boost::interprocess::permissions SharedMemoryPermission;
26 using Ptr = boost::interprocess::offset_ptr<T>;
87 template<
class T,
typename ...TArgs>
96 template<
class T,
typename ...TArgs>
103 void Destroy(
const char* name);
110 template<
class T,
typename ...TArgs>
188template<
class T,
typename ...TArgs>
191 Ptr<T> result = Get<T>(name);
194 return Construct<T>(name, args...);
199template<
class T,
typename ...TArgs>
208 Ptr<T> pValue = this->Get<T>(name);
209 if (pValue !=
nullptr)
216template<
class T,
typename ...TArgs>
222 return new (pResult) T(args...);
239 (void)boost::interprocess::shared_memory_object::remove(this->
GetName());
API to manage and manipulate memory shared between different processes
Definition: SharedMemory.hpp:17
void DestroyUnnamed(SharedMemory::Ptr< T > ptr)
Deallocates the unnamed object in the shared memory, also calling the objects destructor.
Definition: SharedMemory.hpp:226
byte * Allocate(size_t size)
Tries to allocate size amount of bytes in the memory.
Definition: SharedMemory.hpp:172
Arp::String memoryName
Name of memory identifying the shared memory inside the operating system.
Definition: SharedMemory.hpp:144
void ZeroFreeMemory(void)
Writes zero in all bytes not yet allocated.
Definition: SharedMemory.hpp:247
Ptr< T > Get(const char *name)
Tries to find a previously allocated named object.
Definition: SharedMemory.hpp:183
SharedMemoryImpl sharedMemoryImpl
Actual implementation of the shared memory functionality.
Definition: SharedMemory.hpp:147
boost::interprocess::offset_ptr< T > Ptr
Returned pointer types are shared memory based offset pointer.
Definition: SharedMemory.hpp:26
Ptr< T > GetOrConstruct(const char *name, TArgs... args)
Tries to find object identified by name, creates a new one if the object does not exists yet.
Definition: SharedMemory.hpp:189
void Deallocate(byte *pMemory)
Marks the memory pointed to by pMemory available for new allocation requests.
Definition: SharedMemory.hpp:177
bool AllMemoryDeallocated(void)
Checks if all memory has been deallocated.
Definition: SharedMemory.hpp:252
SharedMemory(const char *name)
Opens an existing shared memory.
Definition: SharedMemory.hpp:156
size_t GetSize(void) const
Returns the capacity of the shared memory in bytes.
Definition: SharedMemory.hpp:167
~SharedMemory(void)=default
Deallocates the memory for this management object but not the memory shared between processes.
void Destroy(const char *name)
Deallocates the object in the shared memory, also calling the objects destructor.
Definition: SharedMemory.hpp:206
size_t GetFreeMemory(void) const
Obtain the number of free bytes in the shared memory.
Definition: SharedMemory.hpp:242
SharedMemory(const char *name, size_t memorySize)
Creates an non-existing instance, throws if yet exists.
const Arp::String & GetName(void) const
Returns the name of the memory object.
Definition: SharedMemory.hpp:162
void Remove(void)
Removes the shared memory from the system.
Definition: SharedMemory.hpp:237
Ptr< T > Construct(const char *name, TArgs... args)
Creates a named object in the shared memory.
Definition: SharedMemory.hpp:200
bool CheckSanity(void)
Performs a sanity check over the shared memory.
Definition: SharedMemory.hpp:257
Ptr< T > ConstructUnnamed(TArgs... args)
Creates an unnamed object in the shared memory.
Definition: SharedMemory.hpp:217
@ System
System components used by the System, Device, Plc or Io domains.
Root namespace for the PLCnext API