EMutexData Class Reference

Contains the data associated with a public or private mutex. More...

#include <esynch.h>

Inheritance diagram for EMutexData:

Public Member Functions
	~EMutexData ()
	Class destructor. More...
Void	init (Bool shared)
	Initializes the mutex data. More...
Void	destroy ()
	Destroyes the mutex data. More...
Bool	initialized ()
	Retrieves object initialization status. More...
Long &	mutex ()
	Retrieves the underlying mutex object. More...

Friends
class	EMutexPrivate
class	EMutexPublic
class	EMutexLock

Detailed Description

Contains the data associated with a public or private mutex.

This class is intended to be accessed via a derived object (EMutexPrivate or EMutexPublic). It is used by EMutexLock. If EpcTools is compiled with NATIVE_IPC, then the underlying mutex is a pthread mutex, otherwise the mutex is implemented as a modified spin lock.

Constructor & Destructor Documentation

~EMutexData()

EMutexData::~EMutexData ( )

inline

Class destructor.

Member Function Documentation

destroy()

Void EMutexData::destroy

(

)

Destroyes the mutex data.

init()

Void EMutexData::init

(

Bool

shared

)

Initializes the mutex data.

Parameters

shared

indicates that this mutex is to be shared across processes. This flag is only used if NATIVE_IPC is enabled.

initialized()

Bool EMutexData::initialized ( )

inline

Retrieves object initialization status.

Returns

True indicates the object is initialized, otherwise False.

mutex()

Long& EMutexData::mutex ( )

inline

Retrieves the underlying mutex object.

Returns

The underlying Long mutex variable.

Friends And Related Function Documentation

EMutexLock

friend class EMutexLock

friend

EMutexPrivate

friend class EMutexPrivate

friend

EMutexPublic

friend class EMutexPublic

friend

---

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

• /home/vagrant/share/code/epctools/include/epc/esynch.h