TSharedFTree< TLock > Struct Template Reference

Description:

template<typename TLock>
struct alib::files::TSharedFTree< TLock >

Utility type which implements TSharedMonoVal with class FTree. The result of combining both is an automatic pointer to a FTree that is "self-contained" in the first buffer of a MonoAllocator together with the allocator itself. The tree is deleted and all associated memory is freed when the last copy of the pointer goes out of scope.

Along with the FTree, this shared object includes a SharedLock. See chapter 7.4 Locking Shared Values of the Programmer's Manual of module ALib Monomem for further information on how to protect the contents of this type against thread-racing-conditions.

Template Parameters

TLock

The lock type passed to the template parameter of parent type TSharedMonoVal with the same name. With the inclusion of module ALib Threads in the ALib Distribution, the type-alias alib::SharedFTree chooses type SharedLock. Otherwise, in case ALib is compiled without threading support, the alias chooses void. If it is assured that no racing-conditions occur with shared instances in multithreaded software, the using code may pass void here as well.

Definition at line 507 of file ftree.hpp.

#include <ftree.hpp>

Inheritance diagram for TSharedFTree< TLock >:

Collaboration diagram for TSharedFTree< TLock >:

Public Type Index:
using	Base = monomem::TSharedMonoVal<FTree, HeapAllocator, TLock>
	Exposed shortcut to the base type.
Public Type Index: inherited from TSharedMonoVal< FTree, HeapAllocator, TLock >
using	AllocatorType
	Exposes the monotonic allocator used. Equals to TMonoAllocator<TAllocator>.
using	LockType
	Exposes the lock type specified with template parameter TLock.
using	StoredType
	Exposes the stored type specified with template parameter T.

Public Method Index:
	TSharedFTree ()=default
	Constructs an empty instance, hence a cleared automatic pointer.
	TSharedFTree (size_t initialBufferSizeInKB, unsigned int bufferGrowthInPercent=200)
	TSharedFTree (std::nullptr_t) noexcept
	~TSharedFTree ()
void	DbgCriticalSections (lang::Switch onOff)
TSharedFTree &	operator= (const TSharedFTree &)=default
void	Reset ()
Public Method Index: inherited from TSharedMonoVal< FTree, HeapAllocator, TLock >
	TSharedMonoVal () noexcept
	Default Constructor. Leaves this object nulled.
	TSharedMonoVal (const TSharedMonoVal &other) noexcept
	TSharedMonoVal (HeapAllocator &allocator, size_t initialBufferSizeInKB, unsigned int bufferGrowthInPercent)
	TSharedMonoVal (size_t initialBufferSizeInKB, unsigned int bufferGrowthInPercent)
	TSharedMonoVal (std::nullptr_t) noexcept
	TSharedMonoVal (TSharedMonoVal &&other) noexcept
	~TSharedMonoVal ()
void	Acquire (const CallerInfo &ci) const noexcept
void	AcquireRecursive (const CallerInfo &ci) const noexcept
void	AcquireShared (const CallerInfo &ci) const noexcept
void	ConstructT (TArgs &&... args)
const FTree *	Get () const noexcept
FTree *	Get () noexcept
AllocatorType &	GetAllocator () noexcept
TLock &	GetLock () const noexcept
bool	IsNulled () const noexcept
	operator bool () const noexcept
bool	operator!= (std::nullptr_t) const noexcept
const FTree &	operator* () const noexcept
FTree &	operator* () noexcept
const FTree *	operator-> () const noexcept
FTree *	operator-> () noexcept
TSharedMonoVal &	operator= (const TSharedMonoVal &other) noexcept
void	operator= (std::nullptr_t)
	Assignment of nullptr. Same as SetNulled.
TSharedMonoVal &	operator= (TSharedMonoVal &&other) noexcept
bool	operator== (std::nullptr_t) const noexcept
void	Release (const CallerInfo &ci) const noexcept
void	ReleaseRecursive (const CallerInfo &ci) const noexcept
void	ReleaseShared (const CallerInfo &ci) const noexcept
void	Reset (TArgs &&... args)
const FTree &	Self () const noexcept
FTree &	Self () noexcept
void	SetNulled () noexcept
bool	TryAcquire (const CallerInfo &ci) const noexcept
bool	TryAcquireShared (const CallerInfo &ci) const noexcept
bool	TryAcquireSharedTimed (const Ticks &pointInTime, const CallerInfo &ci) const noexcept
bool	TryAcquireSharedTimed (const Ticks::Duration &waitDuration, const CallerInfo &ci) const noexcept
bool	TryAcquireSharedTimed (const Ticks::Duration::TDuration &waitDuration, const CallerInfo &ci) const noexcept
bool	TryAcquireSharedTimed (const Ticks::TTimePoint &pointInTime, const CallerInfo &ci) const noexcept
bool	TryAcquireTimed (const Ticks &pointInTime, const CallerInfo &ci) const noexcept
bool	TryAcquireTimed (const Ticks::Duration &waitDuration, const CallerInfo &ci) const noexcept
bool	TryAcquireTimed (const Ticks::Duration::TDuration &waitDuration, const CallerInfo &ci) const noexcept
bool	TryAcquireTimed (const Ticks::TTimePoint &pointInTime, const CallerInfo &ci) const noexcept
bool	Unique () const noexcept
unsigned int	UseCount () const noexcept

Additional Inherited Members
Public Static Method Index: inherited from TSharedMonoVal< FTree, HeapAllocator, TLock >
static constexpr size_t	SizeOfAllocation ()
Protected Type Index: inherited from TSharedMonoVal< FTree, HeapAllocator, TLock >
using	FieldMembers
Protected Field Index: inherited from TSharedMonoVal< FTree, HeapAllocator, TLock >
FieldMembers *	members

Type Definition Details:

Base

template<typename TLock >

using Base = monomem::TSharedMonoVal<FTree, HeapAllocator, TLock>

Exposed shortcut to the base type.

Definition at line 510 of file ftree.hpp.

Constructor(s) / Destructor Details:

TSharedFTree() [1/2]

template<typename TLock >

TSharedFTree ( std::nullptr_t )

inlinenoexcept

Constructs an empty instance from std::nullptr. This constructor is necessary to allow assignment of nullptr to values of this type, which clears the automatic pointer.

Definition at line 518 of file ftree.hpp.

TSharedFTree() [2/2]

template<typename TLock >

TSharedFTree ( size_t initialBufferSizeInKB, unsigned int bufferGrowthInPercent = 200 )

inline

Constructor. Calls the constructor of parent TSharedMonoVal and then invokes TSharedMonoVal::ConstructT passing the mono allocator that the parent creates this instance in.
Furthermore calls DbgCriticalSections to enable assertions to locked usage.

Parameters

initialBufferSizeInKB	The initial size of memory buffers. Passed to the allocator given with parent class TSharedMonoVal.
bufferGrowthInPercent	Optional growth factor in percent, applied to the buffer size with each next buffer allocation. Passed to the allocator given with parent class TSharedMonoVal. Should be set to 200, to double the size with each allocation. Defaults to 200.

Definition at line 535 of file ftree.hpp.

Here is the call graph for this function:

~TSharedFTree()

template<typename TLock >

~TSharedFTree ( )

inline

Destructor. Calls DbgCriticalSections to stop checking the integrated TLock.

Definition at line 550 of file ftree.hpp.

Here is the call graph for this function:

Method Details:

DbgCriticalSections()

template<typename TLock >

void DbgCriticalSections

(

lang::Switch

onOff

)

Enables or disables critical section checks between the contained T and the likewise contained TLock.
In case TLock equals void or if symbol ALIB_DEBUG_CRITICAL_SECTIONS is not set, this method is empty (and its use is optimized out).

Parameters

onOff

The switch.

operator=()

template<typename TLock >

TSharedFTree & operator= ( const TSharedFTree< TLock > & )

default

Defaulted copy-assignment operator.

Returns

A reference to this.

Reset()

template<typename TLock >

void Reset ( )

inline

Clears all scanned or otherwise inserted data and re-initializes this object to its constructor defaults and resets the MonoAllocator of the parent class.

All shared instances remain valid (while, of-course, their content is likewise reset).

Definition at line 592 of file ftree.hpp.

Here is the call graph for this function:

---

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

• ftree.hpp