Description:

This type is used for debugging and asserting types TCondition. With debug compilations that class holds one member of this struct, which aggregates all debug information.

Definition at line 314 of file dbgasserters.inl.

Collaboration diagram for alib::threads::DbgConditionAsserter:

[legend]

Public Static Field Index:
static ALIB_DLL const char *	ASSERTION_FORMAT

Public Field Index:
CallerInfo	AcqCI
	Source location of the most recent acquirement.

std::thread::id	AssertExclusiveWaiter

std::atomic< int >	CntWaiters {0}
	The number of currently waiting threads.

const character *	Name
	The name of this instance.

CallerInfo	NotifyCI
	The most recent call to ReleaseAndNotify or.

Thread *	Owner {nullptr}
	Tracks the current owner.

CallerInfo	RelCI
	Source location of the most recent release.

CallerInfo	WaitCI
	The most recent call to WaitForNotification.

Public Method Index:
ALIB_DLL void	Assert (bool cond, const CallerInfo &assertCI, const CallerInfo &ci, const char *headline)

bool	IsOwnedByCurrentThread () const

Field Details:

◆ AcqCI

CallerInfo alib::threads::DbgConditionAsserter::AcqCI

Source location of the most recent acquirement.

Definition at line 318 of file dbgasserters.inl.

◆ AssertExclusiveWaiter

std::thread::id alib::threads::DbgConditionAsserter::AssertExclusiveWaiter

If set from outside, methods WaitForNotification will raise an assertion in the case they are called from a different thread.

Definition at line 323 of file dbgasserters.inl.

◆ ASSERTION_FORMAT

const char * alib::threads::DbgConditionAsserter::ASSERTION_FORMAT

static

Initial value:

=
"Assertion failed in method TCondition::{}"    "\n"
"                 Message: {}"                 "\n"
"                Instance: {}"                 "\n"
                                               "\n"
"               Called By: {}::{}"             "\n"
"                      At: {}:{}"              "\n"
"                  Thread: {}"                 "\n"
                                               "\n"
"           Current Owner: {}"                 "\n"
"             #Of Waiters: {}"                 "\n"
"        Exclusive Waiter: {}"                 "\n"
                                               "\n"
"   Latest Acquisition By: {}::{}"             "\n"
"                      At: {}:{}"              "\n"
"                  Thread: {}"                 "\n"
"       Latest Release By: {}::{}"             "\n"
"                      At: {}:{}"              "\n"
"                  Thread: {}"                 "\n"
                                               "\n"
"          Latest Wait By: {}::{}"             "\n"
"                      At: {}:{}"              "\n"
"                  Thread: {}"                 "\n"
"        Latest Notify By: {}::{}"             "\n"
"                      At: {}:{}"              "\n"
"                  Thread: {}"                 "\n"

The format string used to write exceptions to the console. This string can be changed if the source information is not "clickable" in a user's development environment.

The default string is optimized for JetBrains CLion and is defined as:

Assertion failed in method TCondition::{}
                 Message: {}
                Instance: {}

               Called By: {}::{}
                      At: {}:{}
                  Thread: {}

           Current Owner: {}
             #Of Waiters: {}
        Exclusive Waiter: {}

   Latest Acquisition By: {}::{}
                      At: {}:{}
                  Thread: {}
       Latest Release By: {}::{}
                      At: {}:{}
                  Thread: {}

          Latest Wait By: {}::{}
                      At: {}:{}
                  Thread: {}
        Latest Notify By: {}::{}
                      At: {}:{}
                  Thread: {}

Definition at line 361 of file dbgasserters.inl.

◆ CntWaiters

std::atomic<int> alib::threads::DbgConditionAsserter::CntWaiters {0}

The number of currently waiting threads.

Definition at line 322 of file dbgasserters.inl.

◆ Name

const character* alib::threads::DbgConditionAsserter::Name

The name of this instance.

Definition at line 316 of file dbgasserters.inl.

◆ NotifyCI

CallerInfo alib::threads::DbgConditionAsserter::NotifyCI

The most recent call to ReleaseAndNotify or.

Definition at line 321 of file dbgasserters.inl.

◆ Owner

Thread* alib::threads::DbgConditionAsserter::Owner {nullptr}

Tracks the current owner.

Definition at line 317 of file dbgasserters.inl.

◆ RelCI

CallerInfo alib::threads::DbgConditionAsserter::RelCI

Source location of the most recent release.

Definition at line 319 of file dbgasserters.inl.

◆ WaitCI

CallerInfo alib::threads::DbgConditionAsserter::WaitCI

The most recent call to WaitForNotification.

Definition at line 320 of file dbgasserters.inl.

Method Details:

◆ Assert()

void alib::threads::DbgConditionAsserter::Assert	(	bool	cond,
		const CallerInfo &	assertCI,
		const CallerInfo &	ci,
		const char *	headline )

Writes assertion info and calls ALIB_ASSERT.

See also: Field ASSERTION_FORMAT which allows changing the output format to achieve 'clickable' assertion messages.

Parameters

cond	The condition that is to be met.
assertCI	Location where the assertion is placed.
ci	Location of the call to the method that asserted.
headline	The message.

Definition at line 143 of file dbgasserters.cpp.

Here is the call graph for this function:

◆ IsOwnedByCurrentThread()

bool alib::threads::DbgConditionAsserter::IsOwnedByCurrentThread ( ) const

inline

Returns true if the current owner is the current thread.

Available only in debug-builds.

Returns: true, if the lock is owned by this thread, false if it is owned by another thread or not owned.

Definition at line 379 of file dbgasserters.inl.