LDASTools::AL::ReadWriteLockVariable< T, V > Class Template Reference

Implements read/write lock symantics for a variable. More...

#include <ReadWriteLock.hh>

Public Types
typedef ReadWriteLock::baton_type	baton_type
	Baton. More...
typedef V	element_type
	Type of variable. More...
typedef ReadWriteLock::baton_type	baton_type
	Baton. More...
typedef V	element_type
	Type of variable. More...

Public Member Functions
	ReadWriteLockVariable (baton_type Baton, int Timeout, V &Variable, const char *Filename, int Linenum)
	Constructor. More...
	ReadWriteLockVariable (baton_type Baton, int Timeout, const V &Variable, const char *Filename, int Linenum)
	Constructor. More...
	ReadWriteLockVariable (const ReadWriteLockVariable &Source, const char *Filename, int Linenum)
	Copy constructor. More...
const V &	Var () const
	Read only access to the variable.
V &	Var ()
	Read/Write access to the variable.
	ReadWriteLockVariable (baton_type Baton, int Timeout, V &Variable, const char *Filename, int Linenum)
	Constructor. More...
	ReadWriteLockVariable (baton_type Baton, int Timeout, const V &Variable, const char *Filename, int Linenum)
	Constructor. More...
	ReadWriteLockVariable (const ReadWriteLockVariable &Source, const char *Filename, int Linenum)
	Copy constructor. More...
const V &	Var () const
	Read only access to the variable.
V &	Var ()
	Read/Write access to the variable.

Detailed Description

template<ReadWriteLock::mode_type T, typename V>
class LDASTools::AL::ReadWriteLockVariable< T, V >

Implements read/write lock symantics for a variable.

This class allows for manipulation of variables to be thread safe.

ReadWriteLock::baton_type   baton;
std::string         v;
ReadWriteLockVariable< ReadWriteLock::Write, std::string >
      lock( baton, 0, v);

try
{
  if ( lock.Var( ).size( ) == 0 )
  {
    lock.Var( ).assign( "New value" );
  }
}
catch( )
{
}

Member Typedef Documentation

baton_type [1/2]

template<ReadWriteLock::mode_type T, typename V >

typedef ReadWriteLock::baton_type LDASTools::AL::ReadWriteLockVariable< T, V >::baton_type

Baton.

The resource used to manage resouce access.

baton_type [2/2]

template<ReadWriteLock::mode_type T, typename V >

typedef ReadWriteLock::baton_type LDASTools::AL::ReadWriteLockVariable< T, V >::baton_type

Baton.

The resource used to manage resouce access.

element_type [1/2]

template<ReadWriteLock::mode_type T, typename V >

typedef V LDASTools::AL::ReadWriteLockVariable< T, V >::element_type

Type of variable.

The type of variable being managed.

element_type [2/2]

template<ReadWriteLock::mode_type T, typename V >

typedef V LDASTools::AL::ReadWriteLockVariable< T, V >::element_type

Type of variable.

The type of variable being managed.

Constructor & Destructor Documentation

ReadWriteLockVariable() [1/6]

template<ReadWriteLock::mode_type T, typename V >

LDASTools::AL::ReadWriteLockVariable< T, V >::ReadWriteLockVariable ( baton_type  Baton, int  Timeout, V &  Variable, const char *  Filename, int  Linenum  )

inline

Constructor.

Parameters

[in]	Baton	Baton controlling access to the resource.
[in]	Timeout	Maximum length of time to wait on obtaining the lock.
[in]	Variable	Variable being managed by the class.
[in]	Filename	The filename from where the call was made.
[in]	Linenum	The line number from where the call was made.

ReadWriteLockVariable() [2/6]

template<ReadWriteLock::mode_type T, typename V >

LDASTools::AL::ReadWriteLockVariable< T, V >::ReadWriteLockVariable ( baton_type  Baton, int  Timeout, const V &  Variable, const char *  Filename, int  Linenum  )

inline

Constructor.

Parameters

[in]	Baton	Baton controlling access to the resource.
[in]	Timeout	Maximum length of time to wait on obtaining the lock.
[in]	Variable	Variable being managed by the class.
[in]	Filename	The filename from where the call was made.
[in]	Linenum	The line number from where the call was made.

ReadWriteLockVariable() [3/6]

template<ReadWriteLock::mode_type T, typename V >

LDASTools::AL::ReadWriteLockVariable< T, V >::ReadWriteLockVariable ( const ReadWriteLockVariable< T, V > &  Source, const char *  Filename, int  Linenum  )

inline

Copy constructor.

Parameters

[in]	Source	Source from which to initialize.
[in]	Filename	The filename from where the call was made.
[in]	Linenum	The line number from where the call was made.

ReadWriteLockVariable() [4/6]

template<ReadWriteLock::mode_type T, typename V >

LDASTools::AL::ReadWriteLockVariable< T, V >::ReadWriteLockVariable	(	baton_type	Baton,
		int	Timeout,
		V &	Variable,
		const char *	Filename,
		int	Linenum
	)

Constructor.

Parameters

[in]	Baton	Baton controlling access to the resource.
[in]	Timeout	Maximum length of time to wait on obtaining the lock.
[in]	Variable	Variable being managed by the class.
[in]	Filename	The filename from where the call was made.
[in]	Linenum	The line number from where the call was made.

ReadWriteLockVariable() [5/6]

template<ReadWriteLock::mode_type T, typename V >

LDASTools::AL::ReadWriteLockVariable< T, V >::ReadWriteLockVariable	(	baton_type	Baton,
		int	Timeout,
		const V &	Variable,
		const char *	Filename,
		int	Linenum
	)

Constructor.

Parameters

[in]	Baton	Baton controlling access to the resource.
[in]	Timeout	Maximum length of time to wait on obtaining the lock.
[in]	Variable	Variable being managed by the class.
[in]	Filename	The filename from where the call was made.
[in]	Linenum	The line number from where the call was made.

ReadWriteLockVariable() [6/6]

template<ReadWriteLock::mode_type T, typename V >

LDASTools::AL::ReadWriteLockVariable< T, V >::ReadWriteLockVariable	(	const ReadWriteLockVariable< T, V > &	Source,
		const char *	Filename,
		int	Linenum
	)

Copy constructor.

Parameters

[in]	Source	Source from which to initialize.
[in]	Filename	The filename from where the call was made.
[in]	Linenum	The line number from where the call was made.

---

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

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