tbb::queuing_rw_mutex::scoped_lock Class Reference

The scoped locking pattern. More...

#include <queuing_rw_mutex.h>

List of all members.

Public Member Functions

scoped_lock ()

Construct lock that has not acquired a mutex.

scoped_lock (queuing_rw_mutex &m, bool write=true)

Acquire lock on given mutex.

~scoped_lock ()

Release lock (if lock is held).

void acquire (queuing_rw_mutex &m, bool write=true)

Acquire lock on given mutex.

bool try_acquire (queuing_rw_mutex &m, bool write=true)

Try acquire lock on given mutex.

void release ()

Release lock.

bool upgrade_to_writer ()

Upgrade reader to become a writer.

bool downgrade_to_reader ()

Downgrade writer to become a reader.

Detailed Description

The scoped locking pattern.

It helps to avoid the common problem of forgetting to release lock. It also nicely provides the "node" for queuing locks.

Constructor & Destructor Documentation

tbb::queuing_rw_mutex::scoped_lock::scoped_lock ( ) [inline]

Construct lock that has not acquired a mutex.

Equivalent to zero-initialization of *this.

tbb::queuing_rw_mutex::scoped_lock::scoped_lock	(	queuing_rw_mutex &	m,
		bool	write = `true`
	)			`[inline]`

Acquire lock on given mutex.

Upon entry, *this should not be in the "have acquired a mutex" state.

Member Function Documentation

bool tbb::queuing_rw_mutex::scoped_lock::upgrade_to_writer ( )

Upgrade reader to become a writer.

Returns true if the upgrade happened without re-acquiring the lock and false if opposite

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

queuing_rw_mutex.h

Intel, Pentium, Intel Xeon, Itanium, Intel XScale and VTune are registered trademarks or trademarks of Intel Corporation or its subsidiaries in the United States and other countries.

* Other names and brands may be claimed as the property of others.


Public Member Functions
	scoped_lock ()
	Construct lock that has not acquired a mutex.
	scoped_lock (queuing_rw_mutex &m, bool write=true)
	Acquire lock on given mutex.
	~scoped_lock ()
	Release lock (if lock is held).
void	acquire (queuing_rw_mutex &m, bool write=true)
	Acquire lock on given mutex.
bool	try_acquire (queuing_rw_mutex &m, bool write=true)
	Try acquire lock on given mutex.
void	release ()
	Release lock.
bool	upgrade_to_writer ()
	Upgrade reader to become a writer.
bool	downgrade_to_reader ()
	Downgrade writer to become a reader.