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

NAME

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

SYNOPSIS

       #include <thread.h>

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

Detailed Description

       The WriteLock class is used to protect a section of code through a ThreadLock for 'write'
       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() { WriteLock lock(threadlock); ... operation ... }

       NOTE: do not declare variable as 'WriteLock (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::WriteLock::WriteLock (ThreadLock & _tl) [inline]
       Wait for write access.

       Parameters:
           _tl reference to threadlock to aquire.

       References ost::ThreadLock::writeLock().

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

       References ost::ThreadLock::unlock().

Author

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