Provided by: libcommoncpp2-doc_1.8.1-7_all bug

NAME

       ost::ReadLock - The ReadLock class is used to protect a section of code through a
       ThreadLock for 'read' access to the member function.

SYNOPSIS

       #include <thread.h>

   Public Member Functions
       ReadLock (ThreadLock &_tl)
           Wait for read access.
       ~ReadLock ()
           Post the semaphore automatically.

Detailed Description

       The ReadLock class is used to protect a section of code through a ThreadLock for 'read'
       access to the member function.

       The ThreadLock is automatically released when the object falls out of scope.

       A common use is

       void func_to_protect() { ReadLock lock(threadlock); ... operation ... }

       NOTE: do not declare variable as 'ReadLock (threadlock)', the mutex will be released at
       statement end.

       Author:
           David Sugar dyfet@gnu.org Read mode automatic locker for protected access.

Constructor & Destructor Documentation

   ost::ReadLock::ReadLock (ThreadLock & _tl) [inline]
       Wait for read access.

       Parameters:
           _tl reference to lock to aquire.

       References ost::ThreadLock::readLock().

   ost::ReadLock::~ReadLock () [inline]
       Post the semaphore automatically.

       References ost::ThreadLock::unlock().

Author

       Generated automatically by Doxygen for GNU CommonC++ from the source code.