Interface::InterfaceHandlerBase Class Reference

#include <interfacehandlerbase.h>

Detailed Description

Base class for message handlers attached to Interface objects.

Copyright

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

Inherits Messaging::Handler.

Inherited by Debug::DebugHandler, Http::HttpMessageHandler, and IO::IoInterfaceHandler.

Public Member Functions
	InterfaceHandlerBase ()
	constructor
void	SetCompanyName (const Util::StringAtom &companyName)
	set the company name
const Util::StringAtom &	GetCompanyName () const
	get the company name
void	SetAppName (const Util::StringAtom &appName)
	set the application name
const Util::StringAtom &	GetAppName () const
	get the application name
virtual void	DoWork ()
	optional "per-frame" DoWork method for continuous handlers
Public Member Functions inherited from Messaging::Handler
	Handler ()
	constructor
virtual	~Handler ()
	destructor
virtual void	Open ()
	called once on startup
virtual void	Close ()
	called once before shutdown
bool	IsOpen () const
	return true if open
virtual bool	HandleMessage (const Ptr< Message > &msg)
	handle a message, return true if handled
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

Protected Attributes
Util::StringAtom	companyName
Util::StringAtom	appName
Protected Attributes inherited from Messaging::Handler
bool	isOpen

Private Member Functions
	__DeclareClass (InterfaceHandlerBase)

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

InterfaceHandlerBase()

Interface::InterfaceHandlerBase::InterfaceHandlerBase

(

)

constructor

Member Function Documentation

__DeclareClass()

Interface::InterfaceHandlerBase::__DeclareClass ( InterfaceHandlerBase )

private

DoWork()

void Interface::InterfaceHandlerBase::DoWork ( )

virtual

optional "per-frame" DoWork method for continuous handlers

Reimplemented from Messaging::Handler.

Reimplemented in Debug::DebugHandler, and Http::HttpMessageHandler.

GetAppName()

const Util::StringAtom & Interface::InterfaceHandlerBase::GetAppName ( ) const

inline

get the application name

GetCompanyName()

const Util::StringAtom & Interface::InterfaceHandlerBase::GetCompanyName ( ) const

inline

get the company name

SetAppName()

void Interface::InterfaceHandlerBase::SetAppName ( const Util::StringAtom & appName )

inline

set the application name

SetCompanyName()

void Interface::InterfaceHandlerBase::SetCompanyName ( const Util::StringAtom & companyName )

inline

set the company name

Member Data Documentation

appName

Util::StringAtom Interface::InterfaceHandlerBase::appName

protected

companyName

Util::StringAtom Interface::InterfaceHandlerBase::companyName

protected

---

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

• /github/workspace/code/foundation/interface/interfacehandlerbase.h
• /github/workspace/code/foundation/interface/interfacehandlerbase.cc