Debug::DebugServer Class Reference

#include <debugserver.h>

Detailed Description

The debug server singleton is visible from all threads and keeps track of debug timer and debug counters.

Copyright

(C) 2008 Radon Labs GmbH (C) 2013-2020 Individual contributors, see AUTHORS file

Inherits Core::RefCounted.

Public Member Functions
	DebugServer ()
	constructor
virtual	~DebugServer ()
	destructor
bool	IsOpen () const
	return true if debug server is open
void	RegisterDebugTimer (const Ptr< DebugTimer > &timer)
	register a debug timer
void	UnregisterDebugTimer (const Ptr< DebugTimer > &timer)
	unregister a debug timer
void	RegisterDebugCounter (const Ptr< DebugCounter > &counter)
	register a debug counter
void	UnregisterDebugCounter (const Ptr< DebugCounter > &counter)
	unregister a debug counter
Util::Array< Ptr< DebugTimer > >	GetDebugTimers () const
	get all registered debug timers
Util::Array< Ptr< DebugCounter > >	GetDebugCounters () const
	get all registered debug counters
Ptr< DebugTimer >	GetDebugTimerByName (const Util::StringAtom &name) const
	get debug timer by name, returns invalid ptr if not exists
Ptr< DebugCounter >	GetDebugCounterByName (const Util::StringAtom &name) const
	get debug counter by name, returns invalid ptr if not exists
Public Member Functions inherited from Core::RefCounted
	RefCounted ()
	constructor
int	GetRefCount () const
	get the current refcount
void	AddRef ()
	increment refcount by one
void	Release ()
	decrement refcount and destroy object if refcount is zero
bool	IsInstanceOf (const Rtti &rtti) const
	return true if this object is instance of given class
bool	IsInstanceOf (const Util::String &className) const
	return true if this object is instance of given class by string
bool	IsInstanceOf (const Util::FourCC &classFourCC) const
	return true if this object is instance of given class by fourcc
bool	IsA (const Rtti &rtti) const
	return true if this object is instance of given class, or a derived class
bool	IsA (const Util::String &rttiName) const
	return true if this object is instance of given class, or a derived class, by string
bool	IsA (const Util::FourCC &rttiFourCC) const
	return true if this object is instance of given class, or a derived class, by fourcc
const Util::String &	GetClassName () const
	get the class name
Util::FourCC	GetClassFourCC () const
	get the class FourCC code

Private Member Functions
	__DeclareClass (DebugServer)
	__DeclareInterfaceSingleton (DebugServer)
void	Open ()
	open the debug server
void	Close ()
	close the debug server

Private Attributes
bool	isOpen
Threading::CriticalSection	critSect
Util::Dictionary< Util::StringAtom, Ptr< DebugTimer > >	debugTimers
Util::Dictionary< Util::StringAtom, Ptr< DebugCounter > >	debugCounters

Friends
class	DebugHandler
class	DebugPageHandler

Additional Inherited Members
Static Public Member Functions inherited from Core::RefCounted
static void	DumpRefCountingLeaks ()
	dump refcounting leaks, call at end of application (NEBULA_DEBUG builds only!)
Protected Member Functions inherited from Core::RefCounted
virtual	~RefCounted ()
	destructor (called when refcount reaches zero)

Constructor & Destructor Documentation

DebugServer()

Debug::DebugServer::DebugServer

(

)

constructor

~DebugServer()

Debug::DebugServer::~DebugServer ( )

virtual

destructor

Member Function Documentation

__DeclareClass()

Debug::DebugServer::__DeclareClass ( DebugServer )

private

__DeclareInterfaceSingleton()

Debug::DebugServer::__DeclareInterfaceSingleton ( DebugServer )

private

Close()

void Debug::DebugServer::Close ( )

private

close the debug server

GetDebugCounterByName()

Ptr< DebugCounter > Debug::DebugServer::GetDebugCounterByName

(

const Util::StringAtom &

name

)

const

get debug counter by name, returns invalid ptr if not exists

GetDebugCounters()

Array< Ptr< DebugCounter > > Debug::DebugServer::GetDebugCounters

(

)

const

get all registered debug counters

GetDebugTimerByName()

Ptr< DebugTimer > Debug::DebugServer::GetDebugTimerByName

(

const Util::StringAtom &

name

)

const

get debug timer by name, returns invalid ptr if not exists

GetDebugTimers()

Array< Ptr< DebugTimer > > Debug::DebugServer::GetDebugTimers

(

)

const

get all registered debug timers

IsOpen()

bool Debug::DebugServer::IsOpen ( ) const

inline

return true if debug server is open

Open()

void Debug::DebugServer::Open ( )

private

open the debug server

RegisterDebugCounter()

void Debug::DebugServer::RegisterDebugCounter

(

const Ptr< DebugCounter > &

counter

)

register a debug counter

RegisterDebugTimer()

void Debug::DebugServer::RegisterDebugTimer

(

const Ptr< DebugTimer > &

timer

)

register a debug timer

UnregisterDebugCounter()

void Debug::DebugServer::UnregisterDebugCounter

(

const Ptr< DebugCounter > &

counter

)

unregister a debug counter

UnregisterDebugTimer()

void Debug::DebugServer::UnregisterDebugTimer

(

const Ptr< DebugTimer > &

timer

)

unregister a debug timer

Friends And Related Symbol Documentation

DebugHandler

friend class DebugHandler

friend

DebugPageHandler

friend class DebugPageHandler

friend

Member Data Documentation

critSect

Threading::CriticalSection Debug::DebugServer::critSect

private

debugCounters

Util::Dictionary<Util::StringAtom, Ptr<DebugCounter> > Debug::DebugServer::debugCounters

private

debugTimers

Util::Dictionary<Util::StringAtom, Ptr<DebugTimer> > Debug::DebugServer::debugTimers

private

isOpen

bool Debug::DebugServer::isOpen

private

---

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

• /github/workspace/code/foundation/debug/debugserver.h
• /github/workspace/code/foundation/debug/debugserver.cc