alib::lang::OwnerTry< TOwnable, TOptional > Class Template Reference

Description:

template<typename TOwnable, bool TOptional = false>
class alib::lang::OwnerTry< TOwnable, TOptional >

Similar to class Owner, but calls method TryAcquire instead of Acquire. The result is retrievable with method IsOwning().

See also

Chapter 3.3.1 Class Owner And Its Siblings of the Programmer's Manual of module ALib Threads

Template Parameters

TOwnable	The type to own. Requirements are to have methods TryAcquire and Release available.
TOptional	If true, then checks is performed, whether the given owned is nulled and thus not acquired and released. If false such checks are omitted.

Definition at line 120 of file owner.inl.

Collaboration diagram for alib::lang::OwnerTry< TOwnable, TOptional >:

Public Type Index:
using	OwnablePointer = std::remove_reference_t<TOwnable>*
	The pointer type of the owned object.

Public Method Index:
	OwnerTry (OwnablePointer ownable, const CallerInfo &ci)
	OwnerTry (TOwnable &ownable, const CallerInfo &ci)
	~OwnerTry ()
	Destructor. Invokes Release() on member owned.
bool	IsOwning () const noexcept
bool	Set (OwnablePointer ownable)

Protected Field Index:
CallerInfo	dbgCI
	Caller information. Available only with debug-builds.
bool	isOwning
	The result of the call to TryAcquire.
OwnablePointer	owned
	The resource to acquire and release.

Type Definition Details:

OwnablePointer

template<typename TOwnable, bool TOptional = false>

using alib::lang::OwnerTry< TOwnable, TOptional >::OwnablePointer = std::remove_reference_t<TOwnable>*

The pointer type of the owned object.

Definition at line 126 of file owner.inl.

Field Details:

dbgCI

template<typename TOwnable, bool TOptional = false>

CallerInfo alib::lang::OwnerTry< TOwnable, TOptional >::dbgCI

protected

Caller information. Available only with debug-builds.

Definition at line 132 of file owner.inl.

isOwning

template<typename TOwnable, bool TOptional = false>

bool alib::lang::OwnerTry< TOwnable, TOptional >::isOwning

protected

The result of the call to TryAcquire.

Definition at line 130 of file owner.inl.

owned

template<typename TOwnable, bool TOptional = false>

OwnablePointer alib::lang::OwnerTry< TOwnable, TOptional >::owned

protected

The resource to acquire and release.

Definition at line 129 of file owner.inl.

Constructor(s) / Destructor Details:

OwnerTry() [1/2]

template<typename TOwnable, bool TOptional = false>

alib::lang::OwnerTry< TOwnable, TOptional >::OwnerTry ( TOwnable & ownable, const CallerInfo & ci )

inline

Constructor. Invokes TryAcquire() on member owned.

Parameters

ownable	The ownable to acquire.
ci	Caller information.

Definition at line 164 of file owner.inl.

OwnerTry() [2/2]

template<typename TOwnable, bool TOptional = false>

alib::lang::OwnerTry< TOwnable, TOptional >::OwnerTry ( OwnablePointer ownable, const CallerInfo & ci )

inline

Constructor taking a pointer to the ownable. This constructor is only available if the template parameter TOptional is true.

Parameters

ownable	The ownable to acquire.
ci	Caller information.

Definition at line 172 of file owner.inl.

~OwnerTry()

template<typename TOwnable, bool TOptional = false>

alib::lang::OwnerTry< TOwnable, TOptional >::~OwnerTry ( )

inline

Destructor. Invokes Release() on member owned.

Definition at line 186 of file owner.inl.

Method Details:

IsOwning()

template<typename TOwnable, bool TOptional = false>

bool alib::lang::OwnerTry< TOwnable, TOptional >::IsOwning ( ) const

inlinenoexcept

Returns

true if the try to acquire the owned with construction of this type was successful. Furthermore, true is returned in the case that the template parameter TOptional is true and no ownable was given with construction. Otherwise, false is returned.

Definition at line 203 of file owner.inl.

Set()

template<typename TOwnable, bool TOptional = false>

bool alib::lang::OwnerTry< TOwnable, TOptional >::Set ( OwnablePointer ownable )

inline

Sets the ownable after construction. This method is only available if the template parameter TOptional is true. It must not be called if an object was given with construction already, and it must not be called twice. If done, an assertion is raised.

Parameters

ownable

The ownable to acquire.

Returns

true if the try to acquire the owner was successful, false if not.

Definition at line 193 of file owner.inl.

---

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

• owner.inl