Ocean
Ocean::ScopedSharedLock Class Reference

This class defines a scoped lock object for shared locks. More...

Public Member Functions

 ScopedSharedLock (SharedLock &sharedLock)
 Creates a new shared scoped lock object. More...
 
 ~ScopedSharedLock ()
 Releases a shared scoped lock object. More...
 

Protected Member Functions

 ScopedSharedLock (const ScopedSharedLock &scopedSharedLock)=delete
 Disabled copy constructor. More...
 
ScopedSharedLockoperator= (const ScopedSharedLock &scopedSharedLock)=delete
 Disabled copy operator. More...
 

Private Attributes

SharedLockscopedLock_
 Shared lock object to be used for locking. More...
 

Detailed Description

This class defines a scoped lock object for shared locks.

See also
SharedLock.

Constructor & Destructor Documentation

◆ ScopedSharedLock() [1/2]

Ocean::ScopedSharedLock::ScopedSharedLock ( SharedLock sharedLock)
inline

Creates a new shared scoped lock object.

Parameters
sharedLockShared lock object to be used for locking

◆ ~ScopedSharedLock()

Ocean::ScopedSharedLock::~ScopedSharedLock ( )
inline

Releases a shared scoped lock object.

◆ ScopedSharedLock() [2/2]

Ocean::ScopedSharedLock::ScopedSharedLock ( const ScopedSharedLock scopedSharedLock)
protecteddelete

Disabled copy constructor.

Parameters
scopedSharedLockThe object which would be copied

Member Function Documentation

◆ operator=()

ScopedSharedLock& Ocean::ScopedSharedLock::operator= ( const ScopedSharedLock scopedSharedLock)
protecteddelete

Disabled copy operator.

Parameters
scopedSharedLockThe object which would be copied
Returns
Reference to this object

Field Documentation

◆ scopedLock_

SharedLock& Ocean::ScopedSharedLock::scopedLock_
private

Shared lock object to be used for locking.


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