Odyssey::MessageAdapter Class Reference

This class wraps the MessageListener events, as well as providing a message handling mechanism based on subscriptions. More...

#include <MessageListener.h>

Inheritance diagram for Odyssey::MessageAdapter:

List of all members.

Public Member Functions
virtual void	onMessagePosted ()
	This event occurs when a message is posted to the message queue.
virtual std::pair< bool, Variable >	onMessage (const Message &msg)
	This event is called when a message needs to be handled (it is processed).
virtual void	onRemoved (MessageQueue &queue)
	This event is called when this listener is removed as a listener from the message queue.
virtual void	registerHandler (const String &name, const boost::function< Variable(const Message &)> &func)
	This function registers a new message handler; this subscribes the handler to receive the given message.
virtual void	registerHandler (const String &name, const Callable &func)
	This function registers a callable message handler.
bool	containsHandler (const String &name) const
	This function returns true if a handler is registered for the given message.
Protected Member Functions
	MessageAdapter ()
Classes
class	CallableMessageHandler
class	MessageHandler
class	StdMessageHandler

---

Detailed Description

This class wraps the MessageListener events, as well as providing a message handling mechanism based on subscriptions.

---

Constructor & Destructor Documentation

Odyssey::MessageAdapter::MessageAdapter (   )  [protected]

---

Member Function Documentation

bool Odyssey::MessageAdapter::containsHandler (  const String &  name  )  const

This function returns true if a handler is registered for the given message.

virtual std::pair<bool,Variable> Odyssey::MessageAdapter::onMessage (  const Message &  msg  )  [virtual]

This event is called when a message needs to be handled (it is processed). Implements Odyssey::MessageListener. Reimplemented in Odyssey::Facet.

virtual void Odyssey::MessageAdapter::onMessagePosted (   )  [virtual]

This event occurs when a message is posted to the message queue. Implements Odyssey::MessageListener.

virtual void Odyssey::MessageAdapter::onRemoved (  MessageQueue &  queue  )  [virtual]

This event is called when this listener is removed as a listener from the message queue. Implements Odyssey::MessageListener. Reimplemented in Odyssey::System.

virtual void Odyssey::MessageAdapter::registerHandler (  const String &  name, const Callable &  func )  [virtual]

This function registers a callable message handler.

virtual void Odyssey::MessageAdapter::registerHandler (  const String &  name, const boost::function< Variable(const Message &)> &  func )  [virtual]

This function registers a new message handler; this subscribes the handler to receive the given message.

---

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

• D:/Programs/odyssey/odyssey/include/MessageListener.h

---