tcEDDLockManager Class Reference

OS Abstraction layer for thread safe interlocking. More...

#include <EDDLockManager.h>

List of all members.

Public Member Functions
	tcEDDLockManager (void)
virtual	~tcEDDLockManager (void)
virtual int	CreateLock (void)=0
	Create a Lock Handle.
virtual int	TakeLock (int ahHandle)=0
	take a lock
virtual int	ReleaseLock (int ahHandle)=0
	release a lock
virtual int	DestroyLock (int ahHandle)=0
	destroy a lock

---

Detailed Description

OS Abstraction layer for thread safe interlocking.

The purpose of this class is to provide an abstract interface that must be implemented for an OS using the tcEDDMsgLoop server library. It provides basic thread locking (e.g., critical sections) such that the EDD server implementation may be thread safe.

Definition at line 16 of file EDDLockManager.h.

---

Constructor & Destructor Documentation

tcEDDLockManager::tcEDDLockManager

(

void

)

[inline]

The constructor abstraction does nothing

Definition at line 20 of file EDDLockManager.h.

virtual tcEDDLockManager::~tcEDDLockManager

(

void

)

[inline, virtual]

The descructor abstraction does nothing

Definition at line 22 of file EDDLockManager.h.

---

Member Function Documentation

virtual int tcEDDLockManager::CreateLock

(

void

)

[pure virtual]

Create a Lock Handle.

This method is called to create a lock handle.

Returns:

a handle to a value lock, or 0 on failure

virtual int tcEDDLockManager::DestroyLock

(

int

ahHandle

)

[pure virtual]

destroy a lock

This method is called to free up a resource consumed by a lock handle that is no longer required.

Parameters:

ahHandle

Lock Handle to release from CreateLock

Returns:

0 on success

virtual int tcEDDLockManager::ReleaseLock

(

int

ahHandle

)

[pure virtual]

release a lock

This method is called by an EDD server thread to release a lock. Calls to ReleaseLock should be preceded by a call to TakeLock.

Parameters:

ahHandle

Lock Handle to release from CreateLock

Returns:

0 on success

virtual int tcEDDLockManager::TakeLock

(

int

ahHandle

)

[pure virtual]

take a lock

This method is called by an EDD server thread to take a lock. Calls to TakeLock should be followed by a call to ReleaseLock.

Parameters:

ahHandle

Lock Handle to take from CreateLock

Returns:

0 on success

---

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

• EDDLockManager.h