peak::core::NodeMap::ScopedNodeMapLock Class Reference

RAII object that holds the NodeMap lock. More...

#include <peak/node_map/peak_node_map.hpp>

Public Member Functions
	ScopedNodeMapLock ()=delete
	~ScopedNodeMapLock ()
	ScopedNodeMapLock (const ScopedNodeMapLock &other)=delete
ScopedNodeMapLock &	operator= (const ScopedNodeMapLock &other)=delete
	ScopedNodeMapLock (ScopedNodeMapLock &&other)=delete
ScopedNodeMapLock &	operator= (ScopedNodeMapLock &&other)=delete

Detailed Description

RAII object that holds the NodeMap lock.

Instances of this class are returned by NodeMap::Lock() and keep the associated NodeMap locked for their lifetime. The lock is released automatically when the object is destroyed.

The lock is recursive: if the current thread already holds the lock, additional calls to NodeMap::Lock succeed without blocking. The lock is released only after all ScopedNodeMapLock instances acquired by the thread have been destroyed.

This class cannot be instantiated directly.

Constructor & Destructor Documentation

ScopedNodeMapLock() [1/3]

peak::core::NodeMap::ScopedNodeMapLock::ScopedNodeMapLock ( )

delete

~ScopedNodeMapLock()

peak::core::NodeMap::ScopedNodeMapLock::~ScopedNodeMapLock ( )

inline

ScopedNodeMapLock() [2/3]

peak::core::NodeMap::ScopedNodeMapLock::ScopedNodeMapLock ( const ScopedNodeMapLock & other )

delete

ScopedNodeMapLock() [3/3]

peak::core::NodeMap::ScopedNodeMapLock::ScopedNodeMapLock ( ScopedNodeMapLock && other )

delete

Member Function Documentation

operator=() [1/2]

ScopedNodeMapLock & peak::core::NodeMap::ScopedNodeMapLock::operator= ( const ScopedNodeMapLock & other )

delete

operator=() [2/2]

ScopedNodeMapLock & peak::core::NodeMap::ScopedNodeMapLock::operator= ( ScopedNodeMapLock && other )

delete

---

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

• peak/node_map/peak_node_map.hpp