Fawkes API
Fawkes Development Version
|
Listener for writer events in bbsync plugin. More...
#include "writer_listener.h"
Public Member Functions | |
SyncWriterInterfaceListener (BlackBoardSynchronizationThread *sync_thread, fawkes::Logger *logger, const char *desc) | |
Constructor. More... | |
void | add_interface (fawkes::Interface *interface) |
Add an interface to listen to. More... | |
void | remove_interface (fawkes::Interface *interface) |
Remove an interface to listen to. More... | |
virtual void | bb_interface_writer_added (fawkes::Interface *interface, unsigned int instance_serial) throw () |
A writing instance has been opened for a watched interface. More... | |
virtual void | bb_interface_writer_removed (fawkes::Interface *interface, unsigned int instance_serial) throw () |
A writing instance has been closed for a watched interface. More... | |
![]() | |
BlackBoardInterfaceListener (const char *name_format,...) | |
Constructor. More... | |
virtual | ~BlackBoardInterfaceListener () |
Destructor. More... | |
const char * | bbil_name () const |
Get BBIL name. More... | |
virtual void | bb_interface_data_changed (Interface *interface) throw () |
BlackBoard data changed notification. More... | |
virtual bool | bb_interface_message_received (Interface *interface, Message *message) throw () |
BlackBoard message received notification. More... | |
virtual void | bb_interface_reader_added (Interface *interface, unsigned int instance_serial) throw () |
A reading instance has been opened for a watched interface. More... | |
virtual void | bb_interface_reader_removed (Interface *interface, unsigned int instance_serial) throw () |
A reading instance has been closed for a watched interface. More... | |
Additional Inherited Members | |
![]() | |
enum | QueueEntryType { DATA = 0, MESSAGES = 1, READER = 2, WRITER = 3 } |
Queue entry type. More... | |
typedef std::list< QueueEntry > | InterfaceQueue |
Queue of additions/removal of interfaces. More... | |
typedef std::map< std::string, Interface * > | InterfaceMap |
Map of currently active event subscriptions. More... | |
![]() | |
void | bbil_add_data_interface (Interface *interface) |
Add an interface to the data modification watch list. More... | |
void | bbil_add_message_interface (Interface *interface) |
Add an interface to the message received watch list. More... | |
void | bbil_add_reader_interface (Interface *interface) |
Add an interface to the reader addition/removal watch list. More... | |
void | bbil_add_writer_interface (Interface *interface) |
Add an interface to the writer addition/removal watch list. More... | |
void | bbil_remove_data_interface (Interface *interface) |
Remove an interface to the data modification watch list. More... | |
void | bbil_remove_message_interface (Interface *interface) |
Remove an interface to the message received watch list. More... | |
void | bbil_remove_reader_interface (Interface *interface) |
Remove an interface to the reader addition/removal watch list. More... | |
void | bbil_remove_writer_interface (Interface *interface) |
Remove an interface to the writer addition/removal watch list. More... | |
Interface * | bbil_data_interface (const char *iuid) throw () |
Get interface instance for given UID. More... | |
Interface * | bbil_message_interface (const char *iuid) throw () |
Get interface instance for given UID. More... | |
Interface * | bbil_reader_interface (const char *iuid) throw () |
Get interface instance for given UID. More... | |
Interface * | bbil_writer_interface (const char *iuid) throw () |
Get interface instance for given UID. More... | |
Listener for writer events in bbsync plugin.
This class provides an adapter which reacts to writer events for a given number of (reading) interfaces. Note that the listener is not automatically registered, this has to be done from the outside.
Definition at line 35 of file writer_listener.h.
SyncWriterInterfaceListener::SyncWriterInterfaceListener | ( | BlackBoardSynchronizationThread * | sync_thread, |
fawkes::Logger * | logger, | ||
const char * | desc | ||
) |
Constructor.
sync_thread | parent sync thread to sent events to |
logger | logger for informational output |
desc | description for this interface combination |
Definition at line 44 of file writer_listener.cpp.
void SyncWriterInterfaceListener::add_interface | ( | fawkes::Interface * | interface | ) |
Add an interface to listen to.
interface | interface to listen to for writer events |
Definition at line 58 of file writer_listener.cpp.
References fawkes::BlackBoardInterfaceListener::bbil_add_writer_interface().
Referenced by BlackBoardSynchronizationThread::loop().
|
virtual |
A writing instance has been opened for a watched interface.
This is called whenever a writing instance of the interface you are watching is opened.
interface | interface instance that you supplied to bbil_add_writer_interface() |
instance_serial | the instance serial of the writing instance that has just been added. |
Reimplemented from fawkes::BlackBoardInterfaceListener.
Definition at line 74 of file writer_listener.cpp.
References BlackBoardSynchronizationThread::writer_added().
|
virtual |
A writing instance has been closed for a watched interface.
This is called whenever a writing instance of an interface you are watching is closed.
interface | interface instance that you supplied to bbil_add_writer_interface() |
instance_serial | the instance serial of the writing instance that has just been removed. |
Reimplemented from fawkes::BlackBoardInterfaceListener.
Definition at line 82 of file writer_listener.cpp.
References BlackBoardSynchronizationThread::writer_removed().
void SyncWriterInterfaceListener::remove_interface | ( | fawkes::Interface * | interface | ) |
Remove an interface to listen to.
interface | interface not to listen any longer for writer events |
Definition at line 68 of file writer_listener.cpp.
References fawkes::BlackBoardInterfaceListener::bbil_remove_writer_interface().
Referenced by BlackBoardSynchronizationThread::loop().