Celartem::ReaderWriterLockLockerTempl

Celartem::ReaderWriterLockLockerTempl< isWriter > Class Template Reference

#include <cel_rwlock.h>

List of all members.

Public Member Functions

 ReaderWriterLockLockerTempl ()
 ReaderWriterLockLockerTempl (ReaderWriterLock &rwlock)
 ReaderWriterLockLockerTempl (ReaderWriterLockLockerTempl &rl)
ReaderWriterLockLockerTempl & operator= (ReaderWriterLockLockerTempl &rl)
virtual ~ReaderWriterLockLockerTempl ()
void lock (ReaderWriterLock &rwlock)
void unlock ()
void swap (ReaderWriterLockLockerTempl &r)

Detailed Description

template<bool isWriter>
class Celartem::ReaderWriterLockLockerTempl< isWriter >

This template class is to lock ReaderWriterLock instances.
See also:
ReaderLock, WriterLock, ReaderWriterLock

Definition at line 223 of file cel_rwlock.h.

Constructor & Destructor Documentation

template<bool isWriter>
Celartem::ReaderWriterLockLockerTempl< isWriter >::ReaderWriterLockLockerTempl (  )  [inline]

It does not take any parameter.

Definition at line 229 of file cel_rwlock.h.

template<bool isWriter>
Celartem::ReaderWriterLockLockerTempl< isWriter >::ReaderWriterLockLockerTempl ( ReaderWriterLock &  rwlock  )  [inline]

This constructor creates either of Writer or Reader lock instance and also lock the specified ReaderWriterLock instance.

Parameters:
rwlock ReaderWriterLock class instance.

Definition at line 237 of file cel_rwlock.h.

template<bool isWriter>
Celartem::ReaderWriterLockLockerTempl< isWriter >::ReaderWriterLockLockerTempl ( ReaderWriterLockLockerTempl< isWriter > &  rl  )  [inline]

This constructor duplicates the ReaderWriterLockLockerTempl itself. Please note that if the Writer-Lock is duplicated, causes a dead-lock because ReaderWriterLock usually could not accept two Writers.

Parameters:
rl ReaderWriterLockLockerTempl class instance.

Definition at line 250 of file cel_rwlock.h.

template<bool isWriter>
virtual Celartem::ReaderWriterLockLockerTempl< isWriter >::~ReaderWriterLockLockerTempl (  )  [inline, virtual]

This method also releases the last lock.

Definition at line 265 of file cel_rwlock.h.

Member Function Documentation

template<bool isWriter>
ReaderWriterLockLockerTempl& Celartem::ReaderWriterLockLockerTempl< isWriter >::operator= ( ReaderWriterLockLockerTempl< isWriter > &  rl  )  [inline]

This constructor duplicates the ReaderWriterLockLockerTempl itself. Please note that if the Writer-Lock is duplicated, causes a dead-lock because ReaderWriterLock usually could not accept two Writers.

Parameters:
rl ReaderWriterLockLockerTempl class instance.

Definition at line 256 of file cel_rwlock.h.

template<bool isWriter>
void Celartem::ReaderWriterLockLockerTempl< isWriter >::lock ( ReaderWriterLock &  rwlock  )  [inline]

This method locks the specified ReaderWriterLock instance.

Parameters:
rwlock The instance to lock.

Definition at line 275 of file cel_rwlock.h.

Referenced by Celartem::ReaderWriterLockLockerTempl< isWriter >::operator=(), and Celartem::ReaderWriterLockLockerTempl< isWriter >::ReaderWriterLockLockerTempl().

template<bool isWriter>
void Celartem::ReaderWriterLockLockerTempl< isWriter >::unlock (  )  [inline]

This method releases the last lock.

Definition at line 291 of file cel_rwlock.h.

Referenced by Celartem::ReaderWriterLockLockerTempl< isWriter >::lock(), and Celartem::ReaderWriterLockLockerTempl< isWriter >::~ReaderWriterLockLockerTempl().

template<bool isWriter>
void Celartem::ReaderWriterLockLockerTempl< isWriter >::swap ( ReaderWriterLockLockerTempl< isWriter > &  r  )  [inline]

This method swaps the locking status each other.

Parameters:
r A ReaderWriterLockLockerTempl instance with which exchange the locking status.

Definition at line 306 of file cel_rwlock.h.

The documentation for this class was generated from the following file:
This document is automatically generated using doxygen 1.5.4 at Fri Jun 27 18:23:20 2008.