The Nebula Device 3: Messaging::Handler Class Reference

The Nebula Device 3

Messaging::Handler Class Reference

#include <handler.h>

Inheritance diagram for Messaging::Handler:

Core::RefCounted AsyncGraphics::AsyncGraphicsHandler


Detailed Description

Message handlers are used to process a message. To handle specific messages, derive from Handler and overwrite the method HandleMessage().

(C) 2006 Radon Labs GmbH

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
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::StringGetClassName () const
 get the class name
Util::FourCC GetClassFourCC () const
 get the class FourCC code

Static Public Member Functions

static void DumpRefCountingLeaks ()
 dump refcounting leaks, call at end of application (NEBULA3_DEBUG builds only!)

Member Function Documentation

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 AsyncGraphics::AsyncGraphicsHandler.

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 AsyncGraphics::AsyncGraphicsHandler.

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.

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 AsyncGraphics::AsyncGraphicsHandler.

int Core::RefCounted::GetRefCount (  )  const [inline, inherited]

get the current refcount

Return the current refcount of the object.

void Core::RefCounted::AddRef (  )  [inline, inherited]

increment refcount by one

Increment the refcount of the object.

void Core::RefCounted::Release (  )  [inline, inherited]

decrement refcount and destroy object if refcount is zero

Decrement the refcount and destroy object if refcount is zero.

const Util::String & Core::RefCounted::GetClassName (  )  const [inline, inherited]

get the class name

Get the class name of the object.

Util::FourCC Core::RefCounted::GetClassFourCC (  )  const [inline, inherited]

get the class FourCC code

Get the class FourCC of the object.

void Core::RefCounted::DumpRefCountingLeaks (  )  [static, inherited]

dump refcounting leaks, call at end of application (NEBULA3_DEBUG builds only!)

This method should be called as the very last before an application exits.