Messaging::Handler Class Reference

#include <handler.h>

Detailed Description

Message handlers are used to process a message.

To handle specific messages, derive from Handler and overwrite the method HandleMessage().

Copyright

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

Inherits Core::RefCounted.

Inherited by Animation::AnimEventHandlerBase, Animation::AnimEventServer, and Interface::InterfaceHandlerBase.

Public Member Functions
	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
virtual void	DoWork ()
	optional "per-frame" DoWork method for continuous handlers
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
bool	isOpen

Private Member Functions
	__DeclareClass (Handler)

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

Handler()

Messaging::Handler::Handler

(

)

constructor

~Handler()

Messaging::Handler::~Handler ( )

virtual

destructor

Member Function Documentation

__DeclareClass()

Messaging::Handler::__DeclareClass ( Handler )

private

Close()

void Messaging::Handler::Close ( )

virtual

called once before shutdown

Close the handler.

This method is called once before the handler is detached from the port.

Reimplemented in Animation::AnimEventServer, Debug::DebugHandler, Http::HttpMessageHandler, and IO::IoInterfaceHandler.

DoWork()

void Messaging::Handler::DoWork ( )

virtual

optional "per-frame" DoWork method for continuous handlers

This is an optional method for handlers which need to do continuous work (like a render thread message handler).

This message will be called after messages have been handled.

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

HandleMessage()

bool Messaging::Handler::HandleMessage ( const Ptr< Message > & msg )

virtual

handle a message, return true if handled

Derive this method in a subclass to handle specific messages.

The method should return true only if a message has been handled.

Reimplemented in Animation::AnimEventServer, Http::HttpMessageHandler, and IO::IoInterfaceHandler.

IsOpen()

bool Messaging::Handler::IsOpen ( ) const

inline

return true if open

Open()

void Messaging::Handler::Open ( )

virtual

called once on startup

Open the handler.

This method is called once after the handler has been attached to a port and before the first call to HandleMessage().

Reimplemented in Animation::AnimEventServer, Debug::DebugHandler, Http::HttpMessageHandler, and IO::IoInterfaceHandler.

Member Data Documentation

isOpen

bool Messaging::Handler::isOpen

protected

---

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

• /github/workspace/code/foundation/messaging/handler.h
• /github/workspace/code/foundation/messaging/handler.cc