SharedMemoryProvider< MemoryObject, MemoryObjectMetaInfo > Class Template Reference

The SharedMemoryProvider creates a shared memory segment for writing. More...

#include <ArmarXCore/core/services/sharedmemory/SharedMemoryProvider.h>

Classes
class	Wrapper

Public Types
using	pointer_type
	Pointer type for convenience.

Public Member Functions
int	getCapacity () const
	Retrieve size of usable shared memory.
MemoryObject *	getMemory () const
	Retrieve pointer to shared memory.
MemoryObjectMetaInfo *	getMetaInfo () const
SharedMemoryScopedReadLockPtr	getScopedReadLock () const
	Retrieve scoped lock to the shared memory for reading.
SharedMemoryScopedWriteLockPtr	getScopedWriteLock () const
	Retrieve scoped lock to the shared memory for writing.
int	getSize () const
	Retrieve size of actual used shared memory.
void	lock ()
	Lock shared memory for writing.
void	setMetaInfo (const typename MemoryObjectMetaInfo::PointerType &info, bool threadSafe=false)
	SharedMemoryProvider (const std::string &newMemoryName, typename MemoryObjectMetaInfo::PointerType info)
	Creates a shared memory provider.
void	unlock ()
	Unlock shared memory after writing.
	~SharedMemoryProvider ()
	Destructs the shared memory provider.

Detailed Description

template<class MemoryObject, class MemoryObjectMetaInfo = MetaInfoSizeBase>
class armarx::SharedMemoryProvider< MemoryObject, MemoryObjectMetaInfo >

The SharedMemoryProvider creates a shared memory segment for writing.

It provides synchronized write access to the shared data. The memory content is an array of objects, where the object type is specified as template parameter. The SharedMemoryProvider needs to be constructed, before a SharedMemoryConsumer can be created.

Member Typedef Documentation

pointer_type

template<class MemoryObject, class MemoryObjectMetaInfo = MetaInfoSizeBase>

using pointer_type

Initial value:

 
            std::shared_ptr<SharedMemoryProvider<MemoryObject, MemoryObjectMetaInfo>>

Pointer type for convenience.

Constructor & Destructor Documentation

SharedMemoryProvider()

template<class MemoryObject, class MemoryObjectMetaInfo = MetaInfoSizeBase>

SharedMemoryProvider ( const std::string & newMemoryName, typename MemoryObjectMetaInfo::PointerType info )

inline

Creates a shared memory provider.

Parameters

memoryName	name of the memory for identification in the SharedMemoryConsumer
numberElements	number of elements of type MemoryObject stored in the memory

Exceptions

SharedMemoryException

~SharedMemoryProvider()

template<class MemoryObject, class MemoryObjectMetaInfo = MetaInfoSizeBase>

~SharedMemoryProvider ( )

inline

Destructs the shared memory provider.

Removes the shared memory object of not used by another process.

Member Function Documentation

getCapacity()

template<class MemoryObject, class MemoryObjectMetaInfo = MetaInfoSizeBase>

int getCapacity ( ) const

inline

Retrieve size of usable shared memory.

Returns

size in bytes

getMemory()

template<class MemoryObject, class MemoryObjectMetaInfo = MetaInfoSizeBase>

MemoryObject * getMemory ( ) const

inline

Retrieve pointer to shared memory.

Use getScopedWriteLock() or lock() / unlock() before writing to the memory.

Returns

pointer to the shared memory with type MemoryObject

getMetaInfo()

template<class MemoryObject, class MemoryObjectMetaInfo = MetaInfoSizeBase>

MemoryObjectMetaInfo * getMetaInfo ( ) const

inline

getScopedReadLock()

template<class MemoryObject, class MemoryObjectMetaInfo = MetaInfoSizeBase>

SharedMemoryScopedReadLockPtr getScopedReadLock ( ) const

inline

Retrieve scoped lock to the shared memory for reading.

Returns

shared scoped lock to shared memory

getScopedWriteLock()

template<class MemoryObject, class MemoryObjectMetaInfo = MetaInfoSizeBase>

SharedMemoryScopedWriteLockPtr getScopedWriteLock ( ) const

inline

Retrieve scoped lock to the shared memory for writing.

Returns

scoped lock to shared memory

getSize()

template<class MemoryObject, class MemoryObjectMetaInfo = MetaInfoSizeBase>

int getSize ( ) const

inline

Retrieve size of actual used shared memory.

Returns

size in bytes

lock()

template<class MemoryObject, class MemoryObjectMetaInfo = MetaInfoSizeBase>

void lock ( )

inline

Lock shared memory for writing.

setMetaInfo()

template<class MemoryObject, class MemoryObjectMetaInfo = MetaInfoSizeBase>

void setMetaInfo ( const typename MemoryObjectMetaInfo::PointerType & info, bool threadSafe = false )

inline

unlock()

template<class MemoryObject, class MemoryObjectMetaInfo = MetaInfoSizeBase>

void unlock ( )

inline

Unlock shared memory after writing.

---

The documentation for this class was generated from the following file:

• ArmarXCore/core/services/sharedmemory/SharedMemoryProvider.h