Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages   Examples  

vpr::NullMutex Class Reference

Null mutex wrapper. More...

#include <NullMutex.h>

List of all members.

Public Methods

 NullMutex ()
 ~NullMutex ()
vpr::ReturnStatus acquire () const
 Locks the mutex. More...

vpr::ReturnStatus acquireRead () const
 Acquires a read mutex. More...

vpr::ReturnStatus acquireWrite () const
 Acquires a write mutex. More...

vpr::ReturnStatus tryAcquire () const
 Try to acquire the lock. More...

vpr::ReturnStatus tryacquire_read () const
 Tries to acquire a read mutex. More...

vpr::ReturnStatus tryacquire_write () const
 Tries to acquire a write mutex. More...

vpr::ReturnStatus release () const
 Release the mutex. More...

int test ()
 Tests the current lock status. More...

void dump (FILE *dest=stderr, const char *message="\n------Mutex Dump-----\n") const
 Dumps the mutex debug stuff and current state. More...


Protected Methods

void operator= (const NullMutex &)
 NullMutex (const NullMutex &)

Detailed Description

Null mutex wrapper.

Used to pass a do nothing mutex as a template type.

Date:
1-21-97

Definition at line 58 of file NullMutex.h.

Constructor & Destructor Documentation

vpr::NullMutex::NullMutex (    )  [inline]
 

Definition at line 61 of file NullMutex.h. 

00061 {}

vpr::NullMutex::~NullMutex (    )  [inline]
 

Definition at line 63 of file NullMutex.h. 

00063 {}

vpr::NullMutex::NullMutex (  const NullMutex &    )  [inline, protected]
 

Definition at line 142 of file NullMutex.h. 

00142 {}

Member Function Documentation

vpr::ReturnStatus vpr::NullMutex::acquire (  void    )  const [inline]
 

Locks the mutex.

Returns:
1 is returned if the mutex is acquired.
-1 is returned if an error occurs.

Definition at line 71 of file NullMutex.h. 

00072    {
00073       return vpr::ReturnStatus();
00074    }

vpr::ReturnStatus vpr::NullMutex::acquireRead (    )  const [inline]
 

Acquires a read mutex.

Definition at line 77 of file NullMutex.h. 

00078    {
00079       return this->acquire();     // No special "read" semaphore -- For now
00080    }

vpr::ReturnStatus vpr::NullMutex::acquireWrite (    )  const [inline]
 

Acquires a write mutex.

Definition at line 83 of file NullMutex.h. 

00084    {
00085       return this->acquire();     // No special "write" semaphore -- For now
00086    }

vpr::ReturnStatus vpr::NullMutex::tryAcquire (  void    )  const [inline]
 

Try to acquire the lock.

Returns immediately even if we don't acquire the lock.

Returns:
1 is returned if the mutex is acquired.
0 is returned if the mutex is not acquired.

Definition at line 95 of file NullMutex.h. 

00096    {
00097       return vpr::ReturnStatus();
00098    }

vpr::ReturnStatus vpr::NullMutex::tryacquire_read (    )  const [inline]
 

Tries to acquire a read mutex.

Definition at line 101 of file NullMutex.h. 

00102    {
00103       return this->tryAcquire();
00104    }

vpr::ReturnStatus vpr::NullMutex::tryacquire_write (    )  const [inline]
 

Tries to acquire a write mutex.

Definition at line 107 of file NullMutex.h. 

00108    {
00109       return this->tryAcquire();
00110    }

vpr::ReturnStatus vpr::NullMutex::release (  void    )  const [inline]
 

Release the mutex.

Returns:
0 is returned on success; -1 is returned otherwise.

Definition at line 117 of file NullMutex.h. 

00118    {
00119       return vpr::ReturnStatus();
00120    }

int vpr::NullMutex::test (    )  [inline]
 

Tests the current lock status.

Returns:
0 is returned if the mutex is not locked.
1 is returend if the mutex is locked.

Definition at line 128 of file NullMutex.h. 

00129    {
00130       return 0;     // Just return 0 since it is a null lock
00131    }

void vpr::NullMutex::dump (  FILE *    dest = stderr,
const char *    message = "\n------ Mutex Dump -----\n"
)  const [inline]
 

Dumps the mutex debug stuff and current state.

Definition at line 134 of file NullMutex.h. 

00135    {
00136       std::cerr << message << "NULL Mutex\n";
00137    }

void vpr::NullMutex::operator= (  const NullMutex &    )  [inline, protected]
 

Definition at line 141 of file NullMutex.h. 

00141 {}

The documentation for this class was generated from the following file:
Generated on Sun May 2 14:47:11 2004 for VR Juggler Portable Runtime by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002