framexmit::abstractsemaphore Class Reference
[Frame multicast client/server]

#include <fxmitmutex.hh>

Inheritance diagram for framexmit::abstractsemaphore:

framexmit::mutex framexmit::readwritelock framexmit::recursivemutex

List of all members.

Public Types

enum  locktype { rdlock = 0, wrlock = 1 }
 type of lock More...

Public Member Functions

 abstractsemaphore ()
virtual ~abstractsemaphore ()
virtual void lock ()=0
virtual void readlock ()=0
virtual void writelock ()=0
virtual void unlock ()=0
virtual bool trylock (locktype lck=rdlock)=0


Detailed Description

This class is used as an abstract base class for mutex and locks.

brief Abstract class to manage a semaphore.

Author:
DS, November 98
See also:
Mutex objects

Member Enumeration Documentation

enum framexmit::abstractsemaphore::locktype

type of lock

Enumerator:
rdlock  read lock
wrlock  write lock


Constructor & Destructor Documentation

framexmit::abstractsemaphore::abstractsemaphore (  )  [inline]

Default Costructor. brief Default destructor.

Returns:
void

virtual framexmit::abstractsemaphore::~abstractsemaphore (  )  [virtual]

Abstract virtual destructor. brief Default destructor.

Returns:
void


Member Function Documentation

virtual void framexmit::abstractsemaphore::lock (  )  [pure virtual]

Locks the semaphore (abstract virtual method). brief Semaphore lock function.

Returns:
void

Implemented in framexmit::mutex, framexmit::recursivemutex, and framexmit::readwritelock.

virtual void framexmit::abstractsemaphore::readlock (  )  [pure virtual]

Locks the semaphore to allow read access (abstract virtual method). brief Semaphore lock function.

Returns:
void

Implemented in framexmit::mutex, and framexmit::readwritelock.

virtual void framexmit::abstractsemaphore::writelock (  )  [pure virtual]

Locks the semaphore to allow wrire access (abstract virtual method). brief Semaphore lock function.

Returns:
void

Implemented in framexmit::mutex, and framexmit::readwritelock.

virtual void framexmit::abstractsemaphore::unlock (  )  [pure virtual]

Unlocks the semaphore (abstract virtual method). brief Semaphore unlock function.

Returns:
void

Implemented in framexmit::mutex, framexmit::recursivemutex, and framexmit::readwritelock.

virtual bool framexmit::abstractsemaphore::trylock ( locktype  lck = rdlock  )  [pure virtual]

Tries to lock the semaphore (abstract virtual method). The return argument indicates whether the semaphore was successfully locked, or whether the semaphore was already taken by somebody else. brief Semaphore trylock function.

Returns:
true if semaphore locked

Implemented in framexmit::mutex, framexmit::recursivemutex, and framexmit::readwritelock.


The documentation for this class was generated from the following file:
Generated on Sun Mar 8 19:21:23 2009 for dmt by  doxygen 1.5.4