Fawkes API  Fawkes Development Version
fawkes::BlackBoardNetHandlerInterfaceObserver Class Reference

Interface observer for blackboard network handler. More...

#include <>>

Inheritance diagram for fawkes::BlackBoardNetHandlerInterfaceObserver:

Public Member Functions

 BlackBoardNetHandlerInterfaceObserver (BlackBoard *blackboard, FawkesNetworkHub *hub)
 Constructor. More...
 
virtual ~BlackBoardNetHandlerInterfaceObserver ()
 Destructor. More...
 
virtual void bb_interface_created (const char *type, const char *id) throw ()
 BlackBoard interface created notification. More...
 
virtual void bb_interface_destroyed (const char *type, const char *id) throw ()
 BlackBoard interface destroyed notification. More...
 
- Public Member Functions inherited from fawkes::BlackBoardInterfaceObserver
 BlackBoardInterfaceObserver ()
 Empty constructor. More...
 
virtual ~BlackBoardInterfaceObserver ()
 Destructor. More...
 

Additional Inherited Members

- Protected Types inherited from fawkes::BlackBoardInterfaceObserver
typedef LockMap< std::string, std::list< std::string > > ObservedInterfaceLockMap
 Type for lockable interface type hash sets. More...
 
typedef ObservedInterfaceLockMap::iterator ObservedInterfaceLockMapIterator
 Type for iterator of lockable interface type hash sets. More...
 
- Protected Member Functions inherited from fawkes::BlackBoardInterfaceObserver
void bbio_add_observed_create (const char *type_pattern, const char *id_pattern="*") throw ()
 Add interface creation type to watch list. More...
 
void bbio_add_observed_destroy (const char *type_pattern, const char *id_pattern="*") throw ()
 Add interface destruction type to watch list. More...
 
ObservedInterfaceLockMapbbio_get_observed_create () throw ()
 Get interface creation type watch list. More...
 
ObservedInterfaceLockMapbbio_get_observed_destroy () throw ()
 Get interface destriction type watch list. More...
 

Detailed Description

Interface observer for blackboard network handler.

This class is used by the BlackBoardNetworkHandler to track interface events (creation and destruction) and broadcast them to everybody listening.

Author
Tim Niemueller

Definition at line 34 of file interface_observer.h.

Constructor & Destructor Documentation

◆ BlackBoardNetHandlerInterfaceObserver()

fawkes::BlackBoardNetHandlerInterfaceObserver::BlackBoardNetHandlerInterfaceObserver ( BlackBoard blackboard,
FawkesNetworkHub hub 
)

Constructor.

Parameters
blackboardlocal BlackBoard
hubFawkes network hub to use to send messages

Definition at line 50 of file interface_observer.cpp.

References fawkes::BlackBoardInterfaceObserver::bbio_add_observed_create(), fawkes::BlackBoardInterfaceObserver::bbio_add_observed_destroy(), and fawkes::BlackBoard::register_observer().

◆ ~BlackBoardNetHandlerInterfaceObserver()

fawkes::BlackBoardNetHandlerInterfaceObserver::~BlackBoardNetHandlerInterfaceObserver ( )
virtual

Member Function Documentation

◆ bb_interface_created()

void fawkes::BlackBoardNetHandlerInterfaceObserver::bb_interface_created ( const char *  type,
const char *  id 
)
throw (
)
virtual

BlackBoard interface created notification.

This is called whenever an interface is created for a type that you registered for.

Parameters
typetype of the interface. If you want to store this make a copy as it is not guaranteed that the supplied string exists for longer than the duration of the method call
idID of the newly created interface. If you want to store this make a copy as it is not guaranteed that the supplied string exists for longer than the duration of the method call

Reimplemented from fawkes::BlackBoardInterfaceObserver.

Definition at line 94 of file interface_observer.cpp.

◆ bb_interface_destroyed()

void fawkes::BlackBoardNetHandlerInterfaceObserver::bb_interface_destroyed ( const char *  type,
const char *  id 
)
throw (
)
virtual

BlackBoard interface destroyed notification.

This is called whenever an interface is destroyed for a type that you registered for.

Parameters
typetype of the interface. If you want to store this make a copy as it is not guaranteed that the supplied string exists for longer than the duration of the method call
idID of the newly created interface. If you want to store this make a copy as it is not guaranteed that the supplied string exists for longer than the duration of the method call

Reimplemented from fawkes::BlackBoardInterfaceObserver.

Definition at line 102 of file interface_observer.cpp.


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