Fawkes API  Fawkes Development Version
interface_dispatcher.h
1 
2 /***************************************************************************
3  * interface_dispatcher.cpp - BlackBoard listener and dispatcher
4  *
5  * Created: Thu Oct 09 23:04:59 2008
6  * Copyright 2008 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 __LIBS_GUI_UTILS_INTERFACE_DISPATCHER_H_
25 #define __LIBS_GUI_UTILS_INTERFACE_DISPATCHER_H_
26 
27 #include <cstddef>
28 #include <glibmm/dispatcher.h>
29 #include <blackboard/interface_listener.h>
30 #include <core/utils/lock_queue.h>
31 
32 namespace fawkes {
33 class Interface;
34 
37 {
38  public:
39  InterfaceDispatcher(const char *listener_name, fawkes::Interface *iface,
40  bool message_enqueueing = true);
41 
42  InterfaceDispatcher(const char *listener_name_prefix,
43  std::list<fawkes::Interface *> ifaces,
44  bool message_enqueueing = true);
45 
46  void set_message_enqueueing(bool enqueue);
47 
48  sigc::signal<void, Interface *> signal_data_changed();
49  sigc::signal<void, Interface *, Message *> signal_message_received();
50  sigc::signal<void, Interface *> signal_writer_added();
51  sigc::signal<void, Interface *> signal_writer_removed();
52  sigc::signal<void, Interface *> signal_reader_added();
53  sigc::signal<void, Interface *> signal_reader_removed();
54 
55  virtual void bb_interface_data_changed(Interface *interface) throw();
56  virtual bool bb_interface_message_received(Interface *interface, Message *message) throw();
57  virtual void bb_interface_writer_added(Interface *interface,
58  unsigned int instance_serial) throw();
59  virtual void bb_interface_writer_removed(Interface *interface,
60  unsigned int instance_serial) throw();
61  virtual void bb_interface_reader_added(Interface *interface,
62  unsigned int instance_serial) throw();
63  virtual void bb_interface_reader_removed(Interface *interface,
64  unsigned int instance_serial) throw();
65 
66  protected:
67  virtual void on_data_changed();
68  virtual void on_message_received();
69  virtual void on_writer_added();
70  virtual void on_writer_removed();
71  virtual void on_reader_added();
72  virtual void on_reader_removed();
73 
74  private:
75  void setup_signals();
76 
77  private:
78  bool __message_enqueueing;
79 
80  Glib::Dispatcher __dispatcher_data_changed;
81  Glib::Dispatcher __dispatcher_message_received;
82  Glib::Dispatcher __dispatcher_writer_added;
83  Glib::Dispatcher __dispatcher_writer_removed;
84  Glib::Dispatcher __dispatcher_reader_added;
85  Glib::Dispatcher __dispatcher_reader_removed;
86 
87  sigc::signal<void, Interface *> __signal_data_changed;
88  sigc::signal<void, Interface *, Message *> __signal_message_received;
89  sigc::signal<void, Interface *> __signal_writer_added;
90  sigc::signal<void, Interface *> __signal_writer_removed;
91  sigc::signal<void, Interface *> __signal_reader_added;
92  sigc::signal<void, Interface *> __signal_reader_removed;
93 
94  LockQueue<Interface *> __queue_data_changed;
95  LockQueue<std::pair<Interface *, Message *> > __queue_message_received;
96  LockQueue<Interface *> __queue_writer_added;
97  LockQueue<Interface *> __queue_writer_removed;
98  LockQueue<Interface *> __queue_reader_added;
99  LockQueue<Interface *> __queue_reader_removed;
100 };
101 
102 }
103 
104 #endif
Base class for all messages passed through interfaces in Fawkes BlackBoard.
Definition: message.h:44
virtual void on_data_changed()
Internal event handler.
virtual void on_message_received()
Internal event handler.
virtual void bb_interface_writer_added(Interface *interface, unsigned int instance_serial)
A writing instance has been opened for a watched interface.
virtual void bb_interface_reader_removed(Interface *interface, unsigned int instance_serial)
A reading instance has been closed for a watched interface.
Fawkes library namespace.
virtual bool bb_interface_message_received(Interface *interface, Message *message)
BlackBoard message received notification.
sigc::signal< void, Interface * > signal_writer_removed()
Get "writer removed" signal.
virtual void bb_interface_reader_added(Interface *interface, unsigned int instance_serial)
A reading instance has been opened for a watched interface.
virtual void on_writer_removed()
Internal event handler.
Base class for all Fawkes BlackBoard interfaces.
Definition: interface.h:79
virtual void on_reader_removed()
Internal event handler.
virtual void bb_interface_writer_removed(Interface *interface, unsigned int instance_serial)
A writing instance has been closed for a watched interface.
virtual void bb_interface_data_changed(Interface *interface)
BlackBoard data changed notification.
Queue with a lock.
Definition: lock_queue.h:43
sigc::signal< void, Interface * > signal_reader_removed()
Get "reader removed" signal.
sigc::signal< void, Interface * > signal_writer_added()
Get "writer added" signal.
virtual void on_writer_added()
Internal event handler.
InterfaceDispatcher(const char *listener_name, fawkes::Interface *iface, bool message_enqueueing=true)
Constructor.
virtual void on_reader_added()
Internal event handler.
Interface listener with dispatcher.
sigc::signal< void, Interface * > signal_reader_added()
Get "reader added" signal.
BlackBoard interface listener.
sigc::signal< void, Interface *, Message * > signal_message_received()
Get "message received" signal.
void set_message_enqueueing(bool enqueue)
Set if received messages should be enqueued or not.
sigc::signal< void, Interface * > signal_data_changed()
Get "data changed" signal.