Thread safe view of a Lockable object. More...

#include <LockableView.hpp>

Inheritance diagram for ecstasy::thread::LockableView< L >:

Collaboration diagram for ecstasy::thread::LockableView< L >:

[legend]

Public Types
using	LockableType = L
	Type of the Lockable object.

using	WrappedType = L
	QueryableWrapper Constraint

Public Member Functions
	LockableView (L &lockable)
	Construct a new Lockable View.

	LockableView (const LockableView< L > &other) noexcept
	Copy constructor.

	LockableView (const LockableView< L > &&other) noexcept
	Move constructor.

	~LockableView ()
	Destroy the view, unlocking the internal lockable.

L &	operator* () noexcept
	Access the internal lockable object.

L *	operator-> () noexcept
	Access the internal lockable object pointer.

L *	operator-> () const noexcept
	Access the internal lockable object pointer.

L &	get () noexcept
	Access the internal lockable object.

L &	get () const noexcept
	Access the internal lockable object.

Public Member Functions inherited from ecstasy::thread::LockableViewBase
virtual	~LockableViewBase ()=default

Private Attributes
L &	_lockable

Detailed Description

template<Lockable L>
class ecstasy::thread::LockableView< L >

Thread safe view of a Lockable object.

This view lock the object on construction and unlock it on destruction.

Note: If L is of type const SharedRecursiveMutex, the view will be read only and the lock will be shared.; It can be seen as a thread safe reference wrapper.

Template Parameters

L	Type of the Lockable object.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2024-04-03)

Definition at line 43 of file LockableView.hpp.

Member Typedef Documentation

◆ LockableType

template<Lockable L>

using ecstasy::thread::LockableView< L >::LockableType = L

Type of the Lockable object.

Definition at line 46 of file LockableView.hpp.

◆ WrappedType

template<Lockable L>

using ecstasy::thread::LockableView< L >::WrappedType = L

QueryableWrapper Constraint

Definition at line 48 of file LockableView.hpp.

Constructor & Destructor Documentation

◆ LockableView() [1/3]

template<Lockable L>

ecstasy::thread::LockableView< L >::LockableView ( L & lockable )

inline

Construct a new Lockable View.

Parameters

[in] lockable

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2024-04-03)

Definition at line 57 of file LockableView.hpp.

                                  : _lockable(lockable)
        {
            _lockable.lock();
        }

◆ LockableView() [2/3]

template<Lockable L>

ecstasy::thread::LockableView< L >::LockableView ( const LockableView< L > & other )

inlinenoexcept

Copy constructor.

Note: This relock the object.

Parameters

[in] other Other Lockable View to copy.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2024-04-03)

Definition at line 72 of file LockableView.hpp.

                                                            : _lockable(other._lockable)
        {
            _lockable.lock();
        }

◆ LockableView() [3/3]

template<Lockable L>

ecstasy::thread::LockableView< L >::LockableView ( const LockableView< L > && other )

inlinenoexcept

Move constructor.

Warning: This doesn't really take the lock from other, it just lock the object again. This is because we can't unset the reference of other and it will unlock the object on destruction.; This act as the copy constructor.

Parameters

[in] other Other Lockable View to move.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2024-04-03)

Definition at line 89 of file LockableView.hpp.

                                                             : _lockable(other._lockable)
        {
            _lockable.lock();
        }

◆ ~LockableView()

template<Lockable L>

ecstasy::thread::LockableView< L >::~LockableView ( )

inline

Destroy the view, unlocking the internal lockable.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2024-04-03)

Definition at line 100 of file LockableView.hpp.

        {
            _lockable.unlock();
        }

Member Function Documentation

◆ get() [1/2]

template<Lockable L>

L & ecstasy::thread::LockableView< L >::get ( ) const

inlinenoexcept

Access the internal lockable object.

Returns: L& Reference to the internal lockable object.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2024-10-18)

Definition at line 168 of file LockableView.hpp.

        {
            return _lockable;
        }

◆ get() [2/2]

template<Lockable L>

L & ecstasy::thread::LockableView< L >::get ( )

inlinenoexcept

Access the internal lockable object.

Returns: L& Reference to the internal lockable object.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2024-10-18)

Definition at line 155 of file LockableView.hpp.

        {
            return _lockable;
        }

◆ operator*()

template<Lockable L>

L & ecstasy::thread::LockableView< L >::operator* ( )

inlinenoexcept

Access the internal lockable object.

Returns: L& Reference to the internal lockable object.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2024-04-03)

Definition at line 113 of file LockableView.hpp.

        {
            return _lockable;
        }

◆ operator->() [1/2]

template<Lockable L>

L * ecstasy::thread::LockableView< L >::operator-> ( ) const

inlinenoexcept

Access the internal lockable object pointer.

Warning: This method is const but the object is not. The view does not change the constness of the object, for ensured const access use LockableView<const L>.

Returns: L* Pointer to the internal lockable object.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2024-04-03)

Definition at line 142 of file LockableView.hpp.

        {
            return &_lockable;
        }

◆ operator->() [2/2]

template<Lockable L>

L * ecstasy::thread::LockableView< L >::operator-> ( )

inlinenoexcept

Access the internal lockable object pointer.

Returns: L* Pointer to the internal lockable object.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2024-04-03)

Definition at line 126 of file LockableView.hpp.

        {
            return &_lockable;
        }

Member Data Documentation

◆ _lockable

template<Lockable L>

L& ecstasy::thread::LockableView< L >::_lockable

private

Definition at line 174 of file LockableView.hpp.

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

src/ecstasy/thread/LockableView.hpp

Public Types

Public Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ LockableType

◆ WrappedType

Constructor & Destructor Documentation

◆ LockableView() [1/3]

◆ LockableView() [2/3]

◆ LockableView() [3/3]

◆ ~LockableView()

Member Function Documentation

◆ get() [1/2]

◆ get() [2/2]

◆ operator*()

◆ operator->() [1/2]

◆ operator->() [2/2]

Member Data Documentation

◆ _lockable