vpr::ReadGuard Class Reference

Read Guard wrapper. More...

#include <vpr/Sync/RWGuard.h>

Collaboration diagram for vpr::ReadGuard:

[legend]List of all members.

Public Member Functions
	ReadGuard (RWMutex &lock, int block=1)
	Acquires the lock implicitly.
	~ReadGuard ()
	Releases the lock.
const bool &	locked ()
	Returns: true is returned if this guard is locked.
vpr::ReturnStatus	acquire ()
	Acquires the lock.
vpr::ReturnStatus	tryAcquire ()
	Tries to acquire the lock.
vpr::ReturnStatus	release ()
	Explicity releases the lock.

---

Detailed Description

Read Guard wrapper.

Definition at line 57 of file RWGuard.h.

---

Constructor & Destructor Documentation

vpr::ReadGuard::ReadGuard	(	RWMutex &	lock,
		int	block = 1
	)			[inline]

Acquires the lock implicitly.

If block is 1, then use a blocking acquire.

Definition at line 64 of file RWGuard.h.

References acquire(), vpr::ReturnStatus::success(), and tryAcquire().

                                           : mTheLock(&lock)
   {
      mLockStatus = block ? acquire().success() : tryAcquire().success();
   }

vpr::ReadGuard::~ReadGuard

(

)

[inline]

Releases the lock.

Definition at line 70 of file RWGuard.h.

References vpr::RWMutexPosix::release().

   {
      if ( mLockStatus )
      {
         mTheLock->release();
      }
   }

---

Member Function Documentation

const bool& vpr::ReadGuard::locked

(

)

[inline]

Returns:

true is returned if this guard is locked.

Returns:

false is returned if this guard is not locked.

Definition at line 82 of file RWGuard.h.

   {
      return mLockStatus;
   }

vpr::ReturnStatus vpr::ReadGuard::acquire

(

)

[inline]

Acquires the lock.

Definition at line 88 of file RWGuard.h.

References vpr::RWMutexPosix::acquireRead(), and vpr::ReturnStatus::success().

Referenced by ReadGuard().

   {
      vpr::ReturnStatus status = mTheLock->acquireRead();
      mLockStatus = status.success();
      return status;
   }

vpr::ReturnStatus vpr::ReadGuard::tryAcquire

(

)

[inline]

Tries to acquire the lock.

Definition at line 96 of file RWGuard.h.

References vpr::ReturnStatus::success(), and vpr::RWMutexPosix::tryAcquireRead().

Referenced by ReadGuard().

   {
      vpr::ReturnStatus status = mTheLock->tryAcquireRead();
      mLockStatus = status.success();
      return status;
   }

vpr::ReturnStatus vpr::ReadGuard::release

(

)

[inline]

Explicity releases the lock.

Definition at line 104 of file RWGuard.h.

References vpr::RWMutexPosix::release().

   {
      mLockStatus = false;
      return mTheLock->release();
   }

---

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

• RWGuard.h

---