tbb::interface5::scoped_lock Class Reference

The scoped lock pattern for write locks. More...

#include <reader_writer_lock.h>

Inheritance diagram for tbb::interface5::scoped_lock:

Collaboration diagram for tbb::interface5::scoped_lock:

Public Member Functions
	scoped_lock (reader_writer_lock &lock)
	Construct with blocking attempt to acquire write lock on the passed-in lock. More...
	~scoped_lock ()
	Destructor, releases the write lock. More...
void *	operator new (size_t s)
void	operator delete (void *p)

Private Member Functions
	scoped_lock ()
	Construct scoped_lock that is not holding lock. More...
void __TBB_EXPORTED_METHOD	internal_construct (reader_writer_lock &)
void __TBB_EXPORTED_METHOD	internal_destroy ()
Private Member Functions inherited from tbb::internal::no_copy
	no_copy (const no_copy &)=delete
	no_copy ()=default

Private Attributes
reader_writer_lock *	mutex
	The pointer to the mutex to lock. More...
scoped_lock *	next
	The next queued competitor for the mutex. More...
atomic< status_t >	status
	Status flag of the thread associated with this node. More...

Friends
class	reader_writer_lock

Detailed Description

The scoped lock pattern for write locks.

Scoped locks help avoid the common problem of forgetting to release the lock. This type also serves as the node for queuing locks.

Definition at line 100 of file reader_writer_lock.h.

Constructor & Destructor Documentation

tbb::interface5::scoped_lock::scoped_lock ( reader_writer_lock &  lock )

inline

Construct with blocking attempt to acquire write lock on the passed-in lock.

Definition at line 105 of file reader_writer_lock.h.

References tbb::interface5::internal_construct().

                                              {
            internal_construct(lock);
        }

Here is the call graph for this function:

tbb::interface5::scoped_lock::~scoped_lock ( )

inline

Destructor, releases the write lock.

Definition at line 110 of file reader_writer_lock.h.

References tbb::interface5::internal_destroy().

                       {
            internal_destroy();
        }

Here is the call graph for this function:

tbb::interface5::scoped_lock::scoped_lock ( )

private

Construct scoped_lock that is not holding lock.

Member Function Documentation

void __TBB_EXPORTED_METHOD tbb::interface5::scoped_lock::internal_construct ( reader_writer_lock &  )

private

void __TBB_EXPORTED_METHOD tbb::interface5::scoped_lock::internal_destroy ( )

private

void tbb::interface5::scoped_lock::operator delete ( void *  p )

inline

Definition at line 117 of file reader_writer_lock.h.

References tbb::internal::deallocate_via_handler_v3(), and p.

                                      {
            tbb::internal::deallocate_via_handler_v3(p);
        }

Here is the call graph for this function:

void* tbb::interface5::scoped_lock::operator new ( size_t  s )

inline

Definition at line 114 of file reader_writer_lock.h.

References tbb::internal::allocate_via_handler_v3(), and s.

                                     {
            return tbb::internal::allocate_via_handler_v3(s);
        }

Here is the call graph for this function:

Friends And Related Function Documentation

friend class reader_writer_lock

friend

Definition at line 102 of file reader_writer_lock.h.

Member Data Documentation

reader_writer_lock* tbb::interface5::scoped_lock::mutex

private

The pointer to the mutex to lock.

Definition at line 123 of file reader_writer_lock.h.

scoped_lock* tbb::interface5::scoped_lock::next

private

The next queued competitor for the mutex.

Definition at line 125 of file reader_writer_lock.h.

Referenced by tbb::interface5::end_write(), and tbb::interface5::start_write().

atomic<status_t> tbb::interface5::scoped_lock::status

private

Status flag of the thread associated with this node.

Definition at line 127 of file reader_writer_lock.h.

Referenced by tbb::interface5::set_next_writer(), and tbb::interface5::start_write().

---

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

• reader_writer_lock.h