MessageHandler Class Reference

Gets called by the message manager to display messages to the user. More...

#include <handler.h>

Inheritance diagram for MessageHandler:

[legend]Collaboration diagram for MessageHandler:

[legend]List of all members.

Public Member Functions
	MessageHandler ()
virtual	~MessageHandler ()
	Destrctor will unregister at the message manager.
Protected Member Functions
virtual void	HandleMessage (const Message &m)
	Message handling function.
void	SelectMessageTypes (Message::Type mask)
	Select types of messages to be received.
Private Member Functions
	MessageHandler (const MessageHandler &)
	Do not use.
void	operator= (const MessageHandler &)
	Do not use.
Private Attributes
Message::Type	mtmask
Friends
class	MessageManager
class	LinkedList< MessageHandler >

---

Detailed Description

Gets called by the message manager to display messages to the user.

This class represents a message handler which registers at the message manager to get messages emitted via the Error(), etc. calls.

Each message handler can decide to handle only some few message types, especially this can be used to disable lots of debug messages oterwise generated.

This class is not "C++-safe". The LinkedList is held by the MessageManager.

Definition at line 58 of file handler.h.

---

Constructor & Destructor Documentation

MessageHandler::MessageHandler (  const MessageHandler &   )  [private]

Do not use.

MessageHandler::MessageHandler (   )

Message handler constructor. Called by derived class; there is no point in creating a plain MessageHandler. Constructor will register at the message manager. Definition at line 38 of file handler.cc. References mtmask, and MessageManager::RegisterHandler().

MessageHandler::~MessageHandler (   )  [virtual]

Destrctor will unregister at the message manager. Definition at line 45 of file handler.cc. References MessageManager::UnregisterHandler().

---

Member Function Documentation

void MessageHandler::HandleMessage (  const Message &  m  )  [protected, virtual]

Message handling function. This gets called by the message manager for every message which is of one of the types requested by this handler. The function needs to be overridden; the default version will simply discart the message. The passed message needs (of course) to be copied if not processed immediately. Reimplemented in MessageHandler_Console. Definition at line 22 of file handler.cc. Referenced by MessageManager::_PostMessage().

void MessageHandler::operator= (  const MessageHandler &   )  [private]

Do not use.

void MessageHandler::SelectMessageTypes (  Message::Type  mask  )  [protected]

Select types of messages to be received. After construction, the message handler should call this function to specify which message types it wants to receive and handle. The default is no type. Can be called at "any time" to change the selection. Handlers should probably first call SelectMessageTypes(0) before they deregister / destroy themselves. Definition at line 28 of file handler.cc. References MessageManager::SelectMessageTypes(). Referenced by MessageHandler_Console::MessageHandler_Console(), and MessageHandler_Console::~MessageHandler_Console().

---

Friends And Related Function Documentation

friend class LinkedList< MessageHandler > [friend]

Definition at line 61 of file handler.h.

friend class MessageManager [friend]

Definition at line 60 of file handler.h.

---

Member Data Documentation

Message::Type MessageHandler::mtmask [private]

This data is used by the message manager and stores the message type mask last set via SelectMessageTypes(). Definition at line 65 of file handler.h. Referenced by MessageManager::_PostMessage(), MessageManager::_RecomputeMTMask(), MessageManager::_RegisterHandler(), MessageManager::_SelectMessageTypes(), and MessageHandler().

---

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

• /ray/src/lib/message/handler.h
• /ray/src/lib/message/handler.cc

---