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

Description:

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

Similar to class Owner, but calls methods AcquireShared and ReleaseShared.

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 AcquireShared and ReleaseShared 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 414 of file owner.inl.

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

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

Public Method Index:
	OwnerShared (OwnablePointer ownable, const CallerInfo &ci)
	OwnerShared (TOwnable &ownable, const CallerInfo &ci)
	~OwnerShared ()
	Destructor. Invokes ReleaseShared() on member owned.
void	Set (OwnablePointer ownable)

Protected Field Index:
CallerInfo	dbgCI
	Caller information. Available only with debug-builds.
OwnablePointer	owned
	The resource to acquire and release.

Type Definition Details:

OwnablePointer

template<typename TOwnable, bool TOptional = false>

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

The pointer type of the owned object.

Definition at line 420 of file owner.inl.

Field Details:

dbgCI

template<typename TOwnable, bool TOptional = false>

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

protected

Caller information. Available only with debug-builds.

Definition at line 425 of file owner.inl.

owned

template<typename TOwnable, bool TOptional = false>

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

protected

The resource to acquire and release.

Definition at line 423 of file owner.inl.

Constructor(s) / Destructor Details:

OwnerShared() [1/2]

template<typename TOwnable, bool TOptional = false>

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

inline

Constructor. Invokes AcquireShared() on member owned.

Parameters

ownable	The ownable to acquire.
ci	Caller information.

Definition at line 446 of file owner.inl.

OwnerShared() [2/2]

template<typename TOwnable, bool TOptional = false>

alib::lang::OwnerShared< TOwnable, TOptional >::OwnerShared ( 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 454 of file owner.inl.

~OwnerShared()

template<typename TOwnable, bool TOptional = false>

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

inline

Destructor. Invokes ReleaseShared() on member owned.

Definition at line 467 of file owner.inl.

Method Details:

Set()

template<typename TOwnable, bool TOptional = false>

void alib::lang::OwnerShared< 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.

Definition at line 473 of file owner.inl.

---

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

• owner.inl