DtSharedMemoryPoolClient__rti__ Class Reference

DtSharedMemoryPoolClient__rti__ is used to attach to and access a previously created memory pool. More...

Collaboration diagram for DtSharedMemoryPoolClient__rti__:

List of all members.

Public Member Functions
	DtSharedMemoryPoolClient__rti__ (const MAKRti::DtString &shared_name)
	Attach to an already created memory pool.
virtual	~DtSharedMemoryPoolClient__rti__ ()
	Detaches from the pool.
void *	address () const
	returns the address of the attached memory pool
Protected Attributes
MAKRti::DtString	myName
void *	myAddr
int	myId
Private Member Functions
	DtSharedMemoryPoolClient__rti__ (const DtSharedMemoryPoolClient__rti__ &other)
	Copy Ctor not implemented -- do not copy.
DtSharedMemoryPoolClient__rti__ &	operator= (const DtSharedMemoryPoolClient__rti__ &other)
	Assignment Operator not implemented -- do not copy.

---

Detailed Description

DtSharedMemoryPoolClient__rti__ is used to attach to and access a previously created memory pool.

The pool should already exist, and have been created by the DtSharedMemoryPoolManager class found in this namespace. The pool must have a lifetime greater than the lifetime of this class.

---

Constructor & Destructor Documentation

DtSharedMemoryPoolClient__rti__::DtSharedMemoryPoolClient__rti__

(

const MAKRti::DtString &

shared_name

)

Attach to an already created memory pool.

The CTOR will throw a DtExecption with a useful description of the error if it can not attach.

DtSharedMemoryPoolClient__rti__::~DtSharedMemoryPoolClient__rti__

(

)

[virtual]

Detaches from the pool.

On some platforms, if this is the last DtSharedMemoryPoolClient of the pool, the pool will be destroyed.

References myAddr, and myId.

DtSharedMemoryPoolClient__rti__::DtSharedMemoryPoolClient__rti__

(

const DtSharedMemoryPoolClient__rti__ &

other

)

[private]

Copy Ctor not implemented -- do not copy.

---

Member Function Documentation

void * DtSharedMemoryPoolClient__rti__::address

(

)

const

returns the address of the attached memory pool

References myAddr.

Referenced by DtSmSubscribableMessageQueue__rti__::bucketHeader(), and DtSmSubscribableMessageQueue__rti__::queueHeader().

DtSharedMemoryPoolClient__rti__& DtSharedMemoryPoolClient__rti__::operator=

(

const DtSharedMemoryPoolClient__rti__ &

other

)

[private]

Assignment Operator not implemented -- do not copy.

---

Member Data Documentation

void* DtSharedMemoryPoolClient__rti__::myAddr [protected]

Referenced by address(), and ~DtSharedMemoryPoolClient__rti__().

int DtSharedMemoryPoolClient__rti__::myId [protected]

Referenced by ~DtSharedMemoryPoolClient__rti__().

MAKRti::DtString DtSharedMemoryPoolClient__rti__::myName [protected]

---

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

• vlShmPool__rti__.h
• vlShmPool__rti__.cxx