ReadWriteLock Class Reference

Implements read/write lock symantics. More...

#include <ReadWriteLock.hh>

Classes
class	BusyError
	Busy lock error. More...
class	DeadLockError
	Deadlock error. More...
class	TimedoutError
	Time out error. More...
class	baton_type
	Manager of the read/write lock resource. More...

Public Types
enum	lock_mode { }
	Lock mode. More...
enum	lock_mode { }
	Lock mode. More...
enum	lock_state { }
	Lock state. More...
enum	lock_state { }
	Lock state. More...
typedef enum LDASTools::AL::ReadWriteLock::lock_mode	mode_type
	Lock mode.
typedef enum LDASTools::AL::ReadWriteLock::lock_mode	mode_type
	Lock mode.

Public Member Functions
	ReadWriteLock (baton_type Lock, mode_type Mode, const char *Filename, int Linenum)
	Constructor.
	ReadWriteLock (baton_type Lock, mode_type Mode, bool TryLock, const char *Filename, int Linenum)
	Constructor.
	ReadWriteLock (baton_type Lock, mode_type Mode, int Timeout, const char *Filename, int Linenum)
	Constructor.
	ReadWriteLock (baton_type Lock, mode_type Mode, const char *Filename, int Linenum)
	Constructor.
	ReadWriteLock (baton_type Lock, mode_type Mode, bool TryLock, const char *Filename, int Linenum)
	Constructor.
	ReadWriteLock (baton_type Lock, mode_type Mode, int Timeout, const char *Filename, int Linenum)
	Constructor.
virtual	~ReadWriteLock ()
	Destructor.
virtual	~ReadWriteLock ()
	Destructor.
void	Modify (mode_type Mode, const char *Filename, int Linenum)
	Modify the mode of lock being held on the resource.
void	Modify (mode_type Mode, const char *Filename, int Linenum)
	Modify the mode of lock being held on the resource.
void	Release (const char *Filename, int Linenum)
	Release the lock.
void	Release (const char *Filename, int Linenum)
	Release the lock.

Static Public Member Functions
static baton_type	Baton ()
	Create a baton that is appropriate for use with this class.
static baton_type	Baton ()
	Create a baton that is appropriate for use with this class.
static void	ThreadCancel (void *VLock)
	Handler for thead cancelation.
static void	ThreadCancel (void *VLock)
	Handler for thead cancelation.

Detailed Description

Implements read/write lock symantics.

This class provides proper garbage collection of system resource used to implement thread safe read/write locks.

ReadWriteLock::baton_type   baton;
 
void
threaded_func()
{
  ReadWriteLock lock( baton, ReadWriteLock::WRITE,
                      __FILE__, __LINE__ );
  // modify things that should only be done by a single thread
  ...
  // As lock goes out of scope, the destructor is called
  // thereby releasing lock held on baton.
}

Member Enumeration Documentation

lock_mode [1/2]

enum LDASTools::AL::ReadWriteLock::lock_mode

Lock mode.

Enumerator
READ	< Initial mode
WRITE	< Read lock allows multiple concurrent reads.
READ	< Initial mode
WRITE	< Read lock allows multiple concurrent reads.

lock_mode [2/2]

enum LDASTools::AL::ReadWriteLock::lock_mode

Lock mode.

Enumerator
READ	< Initial mode
WRITE	< Read lock allows multiple concurrent reads.
READ	< Initial mode
WRITE	< Read lock allows multiple concurrent reads.

lock_state [1/2]

enum LDASTools::AL::ReadWriteLock::lock_state

Lock state.

Enumerator
PENDING	< Initial state
ACTIVE	< Lock requested
PENDING	< Initial state
ACTIVE	< Lock requested

lock_state [2/2]

enum LDASTools::AL::ReadWriteLock::lock_state

Lock state.

Enumerator
PENDING	< Initial state
ACTIVE	< Lock requested
PENDING	< Initial state
ACTIVE	< Lock requested

Constructor & Destructor Documentation

ReadWriteLock() [1/6]

LDASTools::AL::ReadWriteLock::ReadWriteLock	(	baton_type	Lock,
		mode_type	Mode,
		const char *	Filename,
		int	Linenum )

Constructor.

Parameters

[in]	Lock	Baton controlling access to the resource.
[in]	Mode	Any of the lock_modes.
[in]	File	The filename from where the call was made.
[in]	Line	The line number from where the call was made.

l.Lock( ReadWriteLock::READ, __FILE__, __LINE__ );

ReadWriteLock() [2/6]

LDASTools::AL::ReadWriteLock::ReadWriteLock	(	baton_type	Lock,
		mode_type	Mode,
		bool	TryLock,
		const char *	Filename,
		int	Linenum )

Constructor.

Parameters

[in]	Lock	Baton controlling access to the resource.
[in]	Mode	Any of the lock_modes.
[in]	TryLock	If true, then return immediately wether or not the lock was obtained.
[in]	File	The filename from where the call was made.
[in]	Line	The line number from where the call was made.

ReadWriteLock() [3/6]

LDASTools::AL::ReadWriteLock::ReadWriteLock	(	baton_type	Lock,
		mode_type	Mode,
		int	Timeout,
		const char *	Filename,
		int	Linenum )

Constructor.

Parameters

[in]	Lock	Baton controlling access to the resource.
[in]	Mode	Any of the lock_modes.
[in]	Timeout	Time limit in seconds in which to acquire the lock. A value of zero (0) indicates that the method should wait until the lock is granted.
[in]	File	The filename from where the call was made.
[in]	Line	The line number from where the call was made.

ReadWriteLock() [4/6]

LDASTools::AL::ReadWriteLock::ReadWriteLock	(	baton_type	Lock,
		mode_type	Mode,
		const char *	Filename,
		int	Linenum )

Constructor.

Parameters

[in]	Lock	Baton controlling access to the resource.
[in]	Mode	Any of the lock_modes.
[in]	File	The filename from where the call was made.
[in]	Line	The line number from where the call was made.

l.Lock( ReadWriteLock::READ, __FILE__, __LINE__ );

ReadWriteLock() [5/6]

LDASTools::AL::ReadWriteLock::ReadWriteLock	(	baton_type	Lock,
		mode_type	Mode,
		bool	TryLock,
		const char *	Filename,
		int	Linenum )

Constructor.

Parameters

[in]	Lock	Baton controlling access to the resource.
[in]	Mode	Any of the lock_modes.
[in]	TryLock	If true, then return immediately wether or not the lock was obtained.
[in]	File	The filename from where the call was made.
[in]	Line	The line number from where the call was made.

ReadWriteLock() [6/6]

LDASTools::AL::ReadWriteLock::ReadWriteLock	(	baton_type	Lock,
		mode_type	Mode,
		int	Timeout,
		const char *	Filename,
		int	Linenum )

Constructor.

Parameters

[in]	Lock	Baton controlling access to the resource.
[in]	Mode	Any of the lock_modes.
[in]	Timeout	Time limit in seconds in which to acquire the lock. A value of zero (0) indicates that the method should wait until the lock is granted.
[in]	File	The filename from where the call was made.
[in]	Line	The line number from where the call was made.

Member Function Documentation

Modify() [1/2]

void LDASTools::AL::ReadWriteLock::Modify	(	mode_type	Mode,
		const char *	Filename,
		int	Linenum )

Modify the mode of lock being held on the resource.

Parameters

[in]	Mode	The new mode to be held on the resource.
[in]	File	The filename from where the call was made.
[in]	Line	The line number from where the call was made.

Modify() [2/2]

void LDASTools::AL::ReadWriteLock::Modify	(	mode_type	Mode,
		const char *	Filename,
		int	Linenum )

Modify the mode of lock being held on the resource.

Parameters

[in]	Mode	The new mode to be held on the resource.
[in]	File	The filename from where the call was made.
[in]	Line	The line number from where the call was made.

Release() [1/2]

void LDASTools::AL::ReadWriteLock::Release	(	const char *	Filename,
		int	Linenum )

Release the lock.

Parameters

[in]	File	The filename from where the call was made.
[in]	Line	The line number from where the call was made.

Release() [2/2]

void LDASTools::AL::ReadWriteLock::Release	(	const char *	Filename,
		int	Linenum )

Release the lock.

Parameters

[in]	File	The filename from where the call was made.
[in]	Line	The line number from where the call was made.

ThreadCancel() [1/2]

void LDASTools::AL::ReadWriteLock::ThreadCancel ( void * VLock )

static

Handler for thead cancelation.

Parameters

[in]

VLock

The VLock is a pointer to a ReadWriteLock object that holds a lock.

ThreadCancel() [2/2]

void LDASTools::AL::ReadWriteLock::ThreadCancel ( void * VLock )

static

Handler for thead cancelation.

Parameters

[in]

VLock

The VLock is a pointer to a ReadWriteLock object that holds a lock.

---

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

• /home/abuild/rpmbuild/BUILD/ldas-tools-al-2.6.7-build/ldas-tools-al-2.6.7/build/include/ldastoolsal/ReadWriteLock.hh
• /home/abuild/rpmbuild/BUILD/ldas-tools-al-2.6.7-build/ldas-tools-al-2.6.7/src/ReadWriteLock.hh
• /home/abuild/rpmbuild/BUILD/ldas-tools-al-2.6.7-build/ldas-tools-al-2.6.7/src/ReadWriteLock.cc