DtSharedMemoryPoolClient Class Reference

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

Collaboration diagram for DtSharedMemoryPoolClient:

Public Member Functions
	DtSharedMemoryPoolClient (const DtString &shared_name)
	Attach to an already created memory pool.
virtual	~DtSharedMemoryPoolClient ()
	Detaches from the pool.
void *	address () const
	returns the address of the attached memory pool

Protected Attributes
DtString	myName
void *	myAddr
int	myId

Private Member Functions
	DtSharedMemoryPoolClient (const DtSharedMemoryPoolClient &other)
	Copy Ctor not implemented – do not copy.
DtSharedMemoryPoolClient &	operator= (const DtSharedMemoryPoolClient &other)
	Assignment Operator not implemented – do not copy.

Detailed Description

DtSharedMemoryPoolClient 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::DtSharedMemoryPoolClient

(

const 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.

virtual DtSharedMemoryPoolClient::~DtSharedMemoryPoolClient ( )

virtual

Detaches from the pool.

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

DtSharedMemoryPoolClient::DtSharedMemoryPoolClient ( const DtSharedMemoryPoolClient &  other )

private

Copy Ctor not implemented – do not copy.

Member Function Documentation

void* DtSharedMemoryPoolClient::address

(

)

const

returns the address of the attached memory pool

DtSharedMemoryPoolClient& DtSharedMemoryPoolClient::operator= ( const DtSharedMemoryPoolClient &  other )

private

Assignment Operator not implemented – do not copy.

Member Data Documentation

void* DtSharedMemoryPoolClient::myAddr

protected

int DtSharedMemoryPoolClient::myId

protected

DtString DtSharedMemoryPoolClient::myName

protected

---

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

• vlShmPool.h