APP_MONITOR Namespace Reference

Classes
struct	ASSERT_CACHE_KEY
	This struct represents a key being used for the std::set that deduplicates asserts during this running session. More...
class	SENTRY
	This is a singleton class intended to manage sentry. More...
class	TRANSACTION
	This represents a sentry transaction which is used for time-performance metrics You start a transaction and can denote "spans" inside the transaction for specific portions of the transaction. More...

Enumerations
enum class	BREADCRUMB_TYPE {   DEFAULT , DBG , ERR , NAVIGATION ,   INFO , QUERY , TRANSACTION , UI ,   USER }
enum class	BREADCRUMB_LEVEL {   FATAL , ERR , WARNING , INFO ,   DBG }

Functions
bool	operator< (const ASSERT_CACHE_KEY &aKey1, const ASSERT_CACHE_KEY &aKey2)
void	AddBreadcrumb (BREADCRUMB_TYPE aType, const wxString &aMsg, const wxString &aCategory, BREADCRUMB_LEVEL aLevel=BREADCRUMB_LEVEL::INFO)
	Add a sentry breadcrumb.
void	AddNavigationBreadcrumb (const wxString &aMsg, const wxString &aCategory)
	Add a navigation breadcrumb.
void	AddTransactionBreadcrumb (const wxString &aMsg, const wxString &aCategory)
	Add a transaction breadcrumb.

Enumeration Type Documentation

BREADCRUMB_LEVEL

enum class APP_MONITOR::BREADCRUMB_LEVEL

strong

Enumerator
FATAL
ERR
WARNING
INFO
DBG

Definition at line 47 of file app_monitor.h.

BREADCRUMB_TYPE

enum class APP_MONITOR::BREADCRUMB_TYPE

strong

Enumerator
DEFAULT
DBG
ERR
NAVIGATION
INFO
QUERY
TRANSACTION
UI
USER

Definition at line 34 of file app_monitor.h.

Function Documentation

AddBreadcrumb()

KICOMMON_API void APP_MONITOR::AddBreadcrumb	(	BREADCRUMB_TYPE	aType,
		const wxString &	aMsg,
		const wxString &	aCategory,
		BREADCRUMB_LEVEL	aLevel )

Add a sentry breadcrumb.

Definition at line 324 of file app_monitor.cpp.

References ERR, and APP_MONITOR::SENTRY::Instance().

Referenced by AddNavigationBreadcrumb(), and AddTransactionBreadcrumb().

AddNavigationBreadcrumb()

KICOMMON_API void APP_MONITOR::AddNavigationBreadcrumb	(	const wxString &	aMsg,
		const wxString &	aCategory )

Add a navigation breadcrumb.

Definition at line 348 of file app_monitor.cpp.

References AddBreadcrumb(), INFO, and NAVIGATION.

Referenced by DIALOG_SHIM::DIALOG_SHIM(), KIWAY::KiFACE(), DIALOG_SHIM::OnCloseWindow(), KIWAY::Player(), KIWAY::PlayerClose(), and KIWAY::ProjectChanged().

AddTransactionBreadcrumb()

KICOMMON_API void APP_MONITOR::AddTransactionBreadcrumb	(	const wxString &	aMsg,
		const wxString &	aCategory )

Add a transaction breadcrumb.

Definition at line 356 of file app_monitor.cpp.

References AddBreadcrumb(), INFO, and TRANSACTION.

Referenced by TOOL_MANAGER::runTool().

operator<()

KICOMMON_API bool APP_MONITOR::operator<	(	const ASSERT_CACHE_KEY &	aKey1,
		const ASSERT_CACHE_KEY &	aKey2 )

Definition at line 318 of file app_monitor.cpp.

References APP_MONITOR::ASSERT_CACHE_KEY::cond, APP_MONITOR::ASSERT_CACHE_KEY::file, APP_MONITOR::ASSERT_CACHE_KEY::func, and APP_MONITOR::ASSERT_CACHE_KEY::line.