Bayonne2 / Common C++ 2 Framework
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Private Attributes
WriteLock Class Reference

The WriteLock class is used to protect a section of code through a ThreadLock for "write" access to the member function. More...

#include <thread.h>

Collaboration diagram for WriteLock:
Collaboration graph
[legend]

Public Member Functions

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

Private Attributes

ThreadLocktl
 

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.nosp@m.@gnu.nosp@m..org Read mode automatic locker for protected access.

Definition at line 468 of file thread.h.

Constructor & Destructor Documentation

WriteLock::WriteLock ( ThreadLock _tl)
inline

Wait for write access.

Parameters
_tlreference to threadlock to aquire.

Definition at line 479 of file thread.h.

WriteLock::~WriteLock ( )
inline

Post the semaphore automatically.

Definition at line 485 of file thread.h.

Field Documentation

ThreadLock& WriteLock::tl
private

Definition at line 471 of file thread.h.


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