SyncInterfaceListener Class Reference

Synchronize two interfaces. More...

#include <sync_listener.h>

Inheritance diagram for SyncInterfaceListener:

[legend]
List of all members.

Public Member Functions

 SyncInterfaceListener (fawkes::Logger *logger, fawkes::Interface *reader, fawkes::Interface *writer, fawkes::BlackBoard *reader_bb, fawkes::BlackBoard *writer_bb)
 Constructor.
virtual ~SyncInterfaceListener ()
 Destructor.
virtual bool bb_interface_message_received (fawkes::Interface *interface, fawkes::Message *message) throw ()
 BlackBoard message received notification.
virtual void bb_interface_data_changed (fawkes::Interface *interface) throw ()
 BlackBoard data changed notification.

Detailed Description

Synchronize two interfaces.

This class synchronizes two interfaces, a reading and a writing instance of the same type. To accomplish this it listens for data changed and message events and forwards them as appropriate to "the other side".

Author:
Tim Niemueller

Definition at line 33 of file sync_listener.h.


Constructor & Destructor Documentation

SyncInterfaceListener::SyncInterfaceListener ( fawkes::Logger logger,
fawkes::Interface reader,
fawkes::Interface writer,
fawkes::BlackBoard reader_bb,
fawkes::BlackBoard writer_bb 
)

Constructor.

Automatically registers the listener with the (two) blackboards as appropriate. It also automatically unregisters in the destructor.

Parameters:
logger logger to write informational output to
reader reading interface instance
writer writing interface instance of the same type as reader
reader_bb the BlackBoard instance the reading instance has been created on
writer_bb the BlackBoard instance the writing instance has been created on

Definition at line 49 of file sync_listener.cpp.

References fawkes::BlackBoardInterfaceListener::bbil_add_data_interface(), fawkes::BlackBoardInterfaceListener::bbil_add_message_interface(), and fawkes::BlackBoard::register_listener().

SyncInterfaceListener::~SyncInterfaceListener (  )  [virtual]

Destructor.

Definition at line 71 of file sync_listener.cpp.

References fawkes::BlackBoard::unregister_listener().


Member Function Documentation

void SyncInterfaceListener::bb_interface_data_changed ( fawkes::Interface interface  )  throw () [virtual]

BlackBoard data changed notification.

This is called whenever the data in an interface that you registered for is modified. This happens if a writer calls the Interface::write() method.

Parameters:
interface interface instance that you supplied to bbil_add_data_interface()

Reimplemented from fawkes::BlackBoardInterfaceListener.

Definition at line 106 of file sync_listener.cpp.

bool SyncInterfaceListener::bb_interface_message_received ( fawkes::Interface interface,
fawkes::Message message 
) throw () [virtual]

BlackBoard message received notification.

This is called whenever a message is received for this interface. This method is only called for writing instances of an interface, never on reading instances. If you have processed the message already, you can order that the message is not enqueued by returning false. Returning true will enqueue the message as usual. You should only do very (very!) quick tasks directly in this method, as it is out of the regular thread context and can harm performance of other plugins and the system as a whole. Note that if you decide to return false the message is not referenced. If you want to keep it longer you have to ref() it by yourself. An example where this would really make sense is a "STOP" message for the motor, which needs to be processed ASAP and maybe even waiting a couple of miliseconds for the next cycle is not acceptable.

Parameters:
interface interface instance that you supplied to bbil_add_message_interface()
message the message that was sent
Returns:
true to get the message enqueued afterwards as usual, false to prevent queuing of the message.

Reimplemented from fawkes::BlackBoardInterfaceListener.

Definition at line 79 of file sync_listener.cpp.

References fawkes::Message::id(), fawkes::RefCount::ref(), fawkes::Message::set_hops(), and fawkes::RefCount::unref().


The documentation for this class was generated from the following files:
Generated on Tue Feb 22 13:32:37 2011 for Fawkes API by  doxygen 1.4.7