Fawkes API  Fawkes Development Version
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
fawkes::MessageMediator Class Referenceabstract

Message mediator interface. More...

#include <message_mediator.h>

Inheritance diagram for fawkes::MessageMediator:

Public Member Functions

virtual ~MessageMediator ()
 Virtual destructor. More...
 
virtual void transmit (Message *message)=0
 Transmit message. More...
 

Detailed Description

Message mediator interface.

The message mediator is used by an interface to communicate messages to the BlackBoard for dispatching.

Author
Tim Niemueller

Definition at line 37 of file message_mediator.h.

Constructor & Destructor Documentation

virtual fawkes::MessageMediator::~MessageMediator ( )
inlinevirtual

Virtual destructor.

Definition at line 41 of file message_mediator.h.

Member Function Documentation

virtual void fawkes::MessageMediator::transmit ( Message message)
pure virtual

Transmit message.

The mediator may modify the message ID of the message.

Parameters
messagemessage to transmit.
Exceptions
BlackBoardNoWritingInstanceExceptionthrown if there is no writing instance for the transmitting interface

Implemented in fawkes::BlackBoardInterfaceProxy, and fawkes::BlackBoardMessageManager.

Referenced by fawkes::Interface::msgq_enqueue(), and fawkes::Interface::msgq_enqueue_copy().


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