EMutexPublic Class Reference

A public mutex (the mutex data is located in shared memory). More...

#include <esynch.h>

Public Member Functions
	EMutexPublic (Bool bInit=True)
	Default constructor. More...
	~EMutexPublic ()
	Class destructor. More...
Void	init ()
	Allocates and initializes the mutex object. More...
Void	destroy ()
	Destroys/releases the mutex object. More...
Void	attach (Int mutexid)
	Associates this public mutex object with the mutex ID located in shared memory. More...
Void	detach ()
	Detaches from the public mutex object. More...
Int	mutexId ()
	Retrieves the mutex ID associated with this public mutex. More...
	operator EMutexDataPublic & ()
	Reference operator overload. More...

Detailed Description

A public mutex (the mutex data is located in shared memory).

Constructor & Destructor Documentation

EMutexPublic()

EMutexPublic::EMutexPublic ( Bool  bInit = True )

inline

Default constructor.

Parameters

bInit

if True, the init method will be called from the constructor.

~EMutexPublic()

EMutexPublic::~EMutexPublic ( )

inline

Class destructor.

Member Function Documentation

attach()

Void EMutexPublic::attach

(

Int

mutexid

)

Associates this public mutex object with the mutex ID located in shared memory.

Parameters

mutexid

the identifier of the mutex.

destroy()

Void EMutexPublic::destroy

(

)

Destroys/releases the mutex object.

detach()

Void EMutexPublic::detach

(

)

Detaches from the public mutex object.

init()

Void EMutexPublic::init

(

)

Allocates and initializes the mutex object.

mutexId()

Int EMutexPublic::mutexId ( )

inline

Retrieves the mutex ID associated with this public mutex.

Returns

operator EMutexDataPublic &()

EMutexPublic::operator EMutexDataPublic &

(

)

Reference operator overload.

Returns

Retrieves the mutex data associated with this public mutex.

---

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

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