Fawkes API  Fawkes Development Version
message_mediator.h
1 
2 /***************************************************************************
3  * message_mediator.h - Fawkes BlackBoard Message Mediator
4  *
5  * Created: Sun Oct 29 17:58:19 2006
6  * Copyright 2006-2009 Tim Niemueller [www.niemueller.de]
7  *
8  ****************************************************************************/
9 
10 /* This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version. A runtime exception applies to
14  * this software (see LICENSE.GPL_WRE file mentioned below for details).
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19  * GNU Library General Public License for more details.
20  *
21  * Read the full text in the LICENSE.GPL_WRE file in the doc directory.
22  */
23 
24 #ifndef __MESSAGE_MEDIATOR_H_
25 #define __MESSAGE_MEDIATOR_H_
26 
27 namespace fawkes {
28 
29 class Interface;
30 class Message;
31 
32 /** Message mediator interface.
33  * The message mediator is used by an interface to communicate messages to the
34  * BlackBoard for dispatching.
35  * @author Tim Niemueller
36  */
38 {
39  public:
40  /** Virtual destructor */
41  virtual ~MessageMediator() {}
42 
43  /** Transmit message.
44  * The mediator may modify the message ID of the message.
45  * @param message message to transmit.
46  * @exception BlackBoardNoWritingInstanceException thrown if there is no writing
47  *instance for the transmitting interface
48  */
49  virtual void transmit(Message *message) = 0;
50 
51 };
52 
53 } // end namespace fawkes
54 
55 #endif
Base class for all messages passed through interfaces in Fawkes BlackBoard.
Definition: message.h:44
Fawkes library namespace.
virtual ~MessageMediator()
Virtual destructor.
virtual void transmit(Message *message)=0
Transmit message.
Message mediator interface.