OpenDaVINCI  4.15.3
odcore::wrapper::SharedMemory Class Referenceabstract

#include <SharedMemory.h>

Inheritance diagram for odcore::wrapper::SharedMemory:
Inheritance graph

Public Member Functions

virtual ~SharedMemory ()
 
virtual bool isValid () const =0
 
virtual const string getName () const =0
 
virtual void lock ()=0
 
virtual void unlock ()=0
 
virtual void * getSharedMemory () const =0
 
virtual uint32_t getSize () const =0
 

Detailed Description

This interface encapsulates all methods necessary to realize a condition.

SharedMemoryFactory

Constructor & Destructor Documentation

odcore::wrapper::SharedMemory::~SharedMemory ( )
virtual

Member Function Documentation

virtual const string odcore::wrapper::SharedMemory::getName ( ) const
pure virtual

This method returns the name for the shared memory.

Returns
name for the shared memory.

Implemented in odcore::wrapper::POSIX::POSIXSharedMemory, and odcore::wrapper::WIN32Impl::WIN32SharedMemory.

virtual void* odcore::wrapper::SharedMemory::getSharedMemory ( ) const
pure virtual

This method returns a pointer to the beginning of the shared memory.

Returns
Pointer to the beginning of the shared memory.

Implemented in odcore::wrapper::POSIX::POSIXSharedMemory, and odcore::wrapper::WIN32Impl::WIN32SharedMemory.

virtual uint32_t odcore::wrapper::SharedMemory::getSize ( ) const
pure virtual

This method returns the size of the shared memory.

Returns
Size of the shared memory.

Implemented in odcore::wrapper::POSIX::POSIXSharedMemory, and odcore::wrapper::WIN32Impl::WIN32SharedMemory.

virtual bool odcore::wrapper::SharedMemory::isValid ( ) const
pure virtual

This method returns true if the shared memory is valid.

Returns
true if the shared memory is valid.

Implemented in odcore::wrapper::POSIX::POSIXSharedMemory, and odcore::wrapper::WIN32Impl::WIN32SharedMemory.

virtual void odcore::wrapper::SharedMemory::lock ( )
pure virtual

This method tries to lock the shared memory.

Implemented in odcore::wrapper::POSIX::POSIXSharedMemory, and odcore::wrapper::WIN32Impl::WIN32SharedMemory.

virtual void odcore::wrapper::SharedMemory::unlock ( )
pure virtual

This method unlocks the shared memory.

Implemented in odcore::wrapper::POSIX::POSIXSharedMemory, and odcore::wrapper::WIN32Impl::WIN32SharedMemory.