Implements read/write lock symantics. More...

#include <ReadWriteLock.hh>

Collaboration diagram for anonymous_namespace{ReadWriteLock.cc}::ReadWriteLock:

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 { NONE = 0x0000 , READ = 0x0001 , WRITE = 0x0002 , NONE = 0x0000 , READ = 0x0001 , WRITE = 0x0002 }
	Lock mode. More...
enum	lock_mode { NONE = 0x0000 , READ = 0x0001 , WRITE = 0x0002 , NONE = 0x0000 , READ = 0x0001 , WRITE = 0x0002 }
	Lock mode. More...
enum	lock_state { STATE_NONE = 0x0000 , PENDING = 0x0001 , ACTIVE = 0x0002 , STATE_NONE = 0x0000 , PENDING = 0x0001 , ACTIVE = 0x0002 }
	Lock state. More...
enum	lock_state { STATE_NONE = 0x0000 , PENDING = 0x0001 , ACTIVE = 0x0002 , STATE_NONE = 0x0000 , PENDING = 0x0001 , ACTIVE = 0x0002 }
	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 int	Interval (int Value)
static int	Interval (int Value)
static int	Timeout (int Value)
static int	Timeout (int Value)
static void	ThreadCancel (void *VLock)
	Handler for thead cancelation.
static void	ThreadCancel (void *VLock)
	Handler for thead cancelation.

Private Attributes
baton_type	sync_baton

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 Typedef Documentation

◆ mode_type [1/2]

typedef enum LDASTools::AL::ReadWriteLock::lock_mode LDASTools::AL::ReadWriteLock::mode_type

Lock mode.

◆ mode_type [2/2]

typedef enum LDASTools::AL::ReadWriteLock::lock_mode LDASTools::AL::ReadWriteLock::mode_type

Lock mode.

Member Enumeration Documentation

◆ lock_mode [1/2]

enum LDASTools::AL::ReadWriteLock::lock_mode

Lock mode.

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

◆ lock_mode [2/2]

enum LDASTools::AL::ReadWriteLock::lock_mode

Lock mode.

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

◆ lock_state [1/2]

enum LDASTools::AL::ReadWriteLock::lock_state

Lock state.

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

◆ lock_state [2/2]

enum LDASTools::AL::ReadWriteLock::lock_state

Lock state.

Enumerator
STATE_NONE
PENDING	< Initial state
ACTIVE	< Lock requested
STATE_NONE
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__ );

anonymous_namespace{ReadWriteLock.cc}::ReadWriteLock::READ

@ READ

< Initial mode

Definition ReadWriteLock.hh:151

◆ 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.

◆ ~ReadWriteLock() [1/2]

LDASTools::AL::ReadWriteLock::~ReadWriteLock ( )

virtual

Destructor.

◆ ~ReadWriteLock() [2/2]

virtual LDASTools::AL::ReadWriteLock::~ReadWriteLock ( )

virtual

Destructor.

Member Function Documentation

◆ Baton() [1/2]

ReadWriteLock::baton_type LDASTools::AL::ReadWriteLock::Baton ( )

static

Create a baton that is appropriate for use with this class.

◆ Baton() [2/2]

baton_type LDASTools::AL::ReadWriteLock::Baton ( )

static

Create a baton that is appropriate for use with this class.

◆ Interval() [1/2]

int LDASTools::AL::ReadWriteLock::Interval ( int Value )

static

◆ Interval() [2/2]

int LDASTools::AL::ReadWriteLock::Interval ( int Value )

static

◆ 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.

◆ Timeout() [1/2]

int LDASTools::AL::ReadWriteLock::Timeout ( int Value )

static

◆ Timeout() [2/2]

int LDASTools::AL::ReadWriteLock::Timeout ( int Value )

static

Member Data Documentation

◆ sync_baton

baton_type LDASTools::AL::ReadWriteLock::sync_baton

private

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ mode_type [1/2]

◆ mode_type [2/2]

Member Enumeration Documentation

◆ lock_mode [1/2]

◆ lock_mode [2/2]

◆ lock_state [1/2]

◆ lock_state [2/2]

Constructor & Destructor Documentation

◆ ReadWriteLock() [1/6]

◆ ReadWriteLock() [2/6]

◆ ReadWriteLock() [3/6]

◆ ReadWriteLock() [4/6]

◆ ReadWriteLock() [5/6]

◆ ReadWriteLock() [6/6]

◆ ~ReadWriteLock() [1/2]

◆ ~ReadWriteLock() [2/2]

Member Function Documentation

◆ Baton() [1/2]

◆ Baton() [2/2]

◆ Interval() [1/2]

◆ Interval() [2/2]

◆ Modify() [1/2]

◆ Modify() [2/2]

◆ Release() [1/2]

◆ Release() [2/2]

◆ ThreadCancel() [1/2]

◆ ThreadCancel() [2/2]

◆ Timeout() [1/2]

◆ Timeout() [2/2]

Member Data Documentation

◆ sync_baton