coil::SharedMemory Class Reference

SharedMemory class. More...

#include <SharedMemory.h>

Public Member Functions
	SharedMemory ()
	Constructor. More...
virtual	~SharedMemory ()
	Destructor. More...
	SharedMemory (const SharedMemory &rhs)
	Copy Constructor. More...
SharedMemory &	operator= (const SharedMemory &rhs)
	Assignment operator. More...
virtual int	create (std::string shm_address, int memory_size=DEFAULT_MEMORY_SIZE)
	Create Shared Memory. More...
virtual int	open (std::string shm_address, int memory_size=DEFAULT_MEMORY_SIZE)
	Open Shared Memory. More...
virtual int	write (const char *data, const int pos, const int size)
	Write Shared Memory. More...
virtual int	read (char *data, const int pos, const int size)
	Read Shared Memory. More...
virtual int	close ()
	Close Shared Memory. More...
virtual unsigned int	get_size ()
virtual std::string	get_addresss ()
virtual char *	get_data ()
virtual int	unlink ()
virtual bool	created ()

Detailed Description

SharedMemory class.

Constructor & Destructor Documentation

coil::SharedMemory::SharedMemory

(

)

Constructor.

Constructor

virtual coil::SharedMemory::~SharedMemory ( )

virtual

Destructor.

Destructor

coil::SharedMemory::SharedMemory

(

const SharedMemory &

rhs

)

Copy Constructor.

Copy Constructor

Parameters

rhs	shared memory object of copy source.

Member Function Documentation

virtual int coil::SharedMemory::close ( )

virtual

Close Shared Memory.

Returns

0: successful, -1: failed

virtual int coil::SharedMemory::create ( std::string  shm_address, int  memory_size = DEFAULT_MEMORY_SIZE  )

virtual

Create Shared Memory.

Parameters

shm_address
memory_size

Returns

0: successful, -1: failed

virtual bool coil::SharedMemory::created ( )

virtual

Returns

virtual std::string coil::SharedMemory::get_addresss ( )

virtual

Returns

address

virtual char* coil::SharedMemory::get_data ( )

virtual

Returns

memory

virtual unsigned int coil::SharedMemory::get_size ( )

virtual

Returns

size

virtual int coil::SharedMemory::open ( std::string  shm_address, int  memory_size = DEFAULT_MEMORY_SIZE  )

virtual

Open Shared Memory.

Parameters

shm_address
memory_size

Returns

0: successful, -1: failed

SharedMemory& coil::SharedMemory::operator=

(

const SharedMemory &

rhs

)

Assignment operator.

Copy a shared memory object.

Parameters

rhs	shared memory object of assignment source.

Returns

Assignment result.

virtual int coil::SharedMemory::read ( char *  data, const int  pos, const int  size  )

virtual

Read Shared Memory.

Parameters

data

Returns

0: successful, -1: failed

virtual int coil::SharedMemory::unlink ( )

virtual

Returns

0: successful, -1: failed

virtual int coil::SharedMemory::write ( const char *  data, const int  pos, const int  size  )

virtual

Write Shared Memory.

Parameters

data

Returns

0: successful, -1: failed

---

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

• /home/openrtm/doc-build/OpenRTM-aist-1.2.1/src/lib/coil/include/coil/SharedMemory.h