Fawkes API  Fawkes Development Version
fawkes::LocalBlackBoard Class Reference

Local BlackBoard. More...

#include <>>

Inheritance diagram for fawkes::LocalBlackBoard:

Public Member Functions

 LocalBlackBoard (size_t memsize)
 Heap Memory Constructor. More...
 
 LocalBlackBoard (size_t memsize, const char *magic_token, bool master=true)
 Shared Memory Constructor. More...
 
virtual ~LocalBlackBoard ()
 Destructor. More...
 
virtual Interfaceopen_for_reading (const char *interface_type, const char *identifier, const char *owner=NULL)
 Open interface for reading. More...
 
virtual Interfaceopen_for_writing (const char *interface_type, const char *identifier, const char *owner=NULL)
 Open interface for writing. More...
 
virtual void close (Interface *interface)
 Close interface. More...
 
virtual InterfaceInfoListlist_all ()
 Get list of all currently existing interfaces. More...
 
virtual InterfaceInfoListlist (const char *type_pattern, const char *id_pattern)
 Get list of interfaces matching type and ID patterns. More...
 
virtual bool is_alive () const throw ()
 Check if the BlackBoard is still alive. More...
 
virtual bool try_aliveness_restore () throw ()
 Try to restore the aliveness of the BlackBoard instance. More...
 
virtual std::list< Interface * > open_multiple_for_reading (const char *type_pattern, const char *id_pattern="*", const char *owner=NULL)
 Open multiple interfaces for reading. More...
 
virtual void start_nethandler (FawkesNetworkHub *hub)
 Start network handler. More...
 
const BlackBoardMemoryManagermemory_manager () const
 Get memory manager. More...
 
- Public Member Functions inherited from fawkes::BlackBoard
virtual ~BlackBoard ()
 Destructor. More...
 
virtual Interfaceopen_for_reading_f (const char *interface_type, const char *identifier,...)
 Open interface for reading with identifier format string. More...
 
virtual Interfaceopen_for_writing_f (const char *interface_type, const char *identifier,...)
 Open interface for writing with identifier format string. More...
 
template<class InterfaceType >
std::list< InterfaceType * > open_multiple_for_reading (const char *id_pattern="*", const char *owner=NULL)
 Open all interfaces of given type for reading. More...
 
template<class InterfaceType >
InterfaceType * open_for_reading (const char *identifier, const char *owner=NULL)
 Get interface of given type. More...
 
template<class InterfaceType >
InterfaceType * open_for_writing (const char *identifier, const char *owner=NULL)
 Get writer interface of given type. More...
 
template<class InterfaceType >
InterfaceType * open_for_reading_f (const char *identifier,...)
 Get interface of given type with identifier format string. More...
 
template<class InterfaceType >
InterfaceType * open_for_writing_f (const char *identifier,...)
 Get writer interface of given type with identifier format string. More...
 
virtual void register_listener (BlackBoardInterfaceListener *listener, ListenerRegisterFlag flag=BBIL_FLAG_ALL)
 Register BB event listener. More...
 
virtual void update_listener (BlackBoardInterfaceListener *listener, ListenerRegisterFlag flag=BBIL_FLAG_ALL)
 Update BB event listener. More...
 
virtual void unregister_listener (BlackBoardInterfaceListener *listener)
 Unregister BB interface listener. More...
 
virtual void register_observer (BlackBoardInterfaceObserver *observer)
 Register BB interface observer. More...
 
virtual void unregister_observer (BlackBoardInterfaceObserver *observer)
 Unregister BB interface observer. More...
 
std::string demangle_fawkes_interface_name (const char *type)
 Produce interface name from C++ signature. More...
 
std::string format_identifier (const char *identifier_format, va_list arg)
 Get formatted identifier string. More...
 

Static Public Member Functions

static void cleanup (const char *magic_token, bool use_lister=false)
 Cleanup orphaned BlackBoard segments. More...
 

Additional Inherited Members

- Public Types inherited from fawkes::BlackBoard
enum  ListenerRegisterFlag {
  BBIL_FLAG_DATA = 1, BBIL_FLAG_MESSAGES = 2, BBIL_FLAG_READER = 4, BBIL_FLAG_WRITER = 8,
  BBIL_FLAG_ALL = 15
}
 Flags to constrain listener registration/updates. More...
 
- Protected Member Functions inherited from fawkes::BlackBoard
 BlackBoard (bool create_notifier=true)
 Constructor. More...
 
- Protected Attributes inherited from fawkes::BlackBoard
BlackBoardNotifier__notifier
 Notifier for BB events. More...
 

Detailed Description

Local BlackBoard.

See also
Interface
Message
Author
Tim Niemueller

Definition at line 44 of file local.h.

Constructor & Destructor Documentation

◆ LocalBlackBoard() [1/2]

fawkes::LocalBlackBoard::LocalBlackBoard ( size_t  memsize)

Heap Memory Constructor.

Parameters
memsizesize of memory in bytes

Definition at line 73 of file local.cpp.

References fawkes::BlackBoard::__notifier.

◆ LocalBlackBoard() [2/2]

fawkes::LocalBlackBoard::LocalBlackBoard ( size_t  memsize,
const char *  magic_token,
bool  master = true 
)

Shared Memory Constructor.

Parameters
memsizesize of memory in bytes
magic_tokenmagic token used for shared memory segment
mastertrue to operate in master mode, false otherwise

Definition at line 56 of file local.cpp.

References fawkes::BlackBoard::__notifier.

◆ ~LocalBlackBoard()

fawkes::LocalBlackBoard::~LocalBlackBoard ( )
virtual

Destructor.

Definition at line 87 of file local.cpp.

References fawkes::Thread::cancel(), and fawkes::Thread::join().

Member Function Documentation

◆ cleanup()

void fawkes::LocalBlackBoard::cleanup ( const char *  magic_token,
bool  use_lister = false 
)
static

Cleanup orphaned BlackBoard segments.

This erase orphaned shared memory segments that belonged to a BlackBoard.

Parameters
magic_tokenmagic token of shared memory segments
use_listertrue to use a lister with console output

Definition at line 177 of file local.cpp.

References fawkes::SharedMemory::erase_orphaned().

◆ close()

void fawkes::LocalBlackBoard::close ( Interface interface)
virtual

Close interface.

Parameters
interfaceinterface to close

Implements fawkes::BlackBoard.

Definition at line 136 of file local.cpp.

References fawkes::BlackBoardInterfaceManager::close().

◆ is_alive()

bool fawkes::LocalBlackBoard::is_alive ( ) const
throw (
)
virtual

Check if the BlackBoard is still alive.

Returns
true, if the BlackBoard is still alive and may be used, false otherwise.

Implements fawkes::BlackBoard.

Definition at line 157 of file local.cpp.

◆ list()

InterfaceInfoList * fawkes::LocalBlackBoard::list ( const char *  type_pattern,
const char *  id_pattern 
)
virtual

Get list of interfaces matching type and ID patterns.

See the fnmatch() documentation for possible patterns.

Parameters
type_patternpattern with shell like globs (* for any number of characters, ? for exactly one character) to match the interface type.
id_patternpattern with shell like globs (* for any number of characters, ? for exactly one character) to match the interface ID.
Returns
list of interfaces

Implements fawkes::BlackBoard.

Definition at line 150 of file local.cpp.

References fawkes::BlackBoardInterfaceManager::list().

◆ list_all()

InterfaceInfoList * fawkes::LocalBlackBoard::list_all ( )
virtual

Get list of all currently existing interfaces.

Returns
list of interfaces

Implements fawkes::BlackBoard.

Definition at line 143 of file local.cpp.

References fawkes::BlackBoardInterfaceManager::list_all().

◆ memory_manager()

const BlackBoardMemoryManager * fawkes::LocalBlackBoard::memory_manager ( ) const

Get memory manager.

CAUTION: This is NOT meant to be used in your application. This returns a pointer to the used memory manager. The return type is declared const. Use this only for debugging purposes to output info about the BlackBoard memory.

Returns
const pointer to memory manager

Definition at line 198 of file local.cpp.

◆ open_for_reading()

Interface * fawkes::LocalBlackBoard::open_for_reading ( const char *  type,
const char *  identifier,
const char *  owner = NULL 
)
virtual

Open interface for reading.

This will create a new interface instance of the given type. The result can be casted to the appropriate type.

Parameters
typetype of the interface
identifieridentifier of the interface
ownername of entity which opened this interface. If using the BlackBoardAspect to access the blackboard leave this untouched unless you have a good reason.
Returns
new fully initialized interface instance of requested type
Exceptions
OutOfMemoryExceptionthrown if there is not enough free space for the requested interface.

Implements fawkes::BlackBoard.

Definition at line 101 of file local.cpp.

References fawkes::BlackBoardInterfaceManager::open_for_reading().

◆ open_for_writing()

Interface * fawkes::LocalBlackBoard::open_for_writing ( const char *  type,
const char *  identifier,
const char *  owner = NULL 
)
virtual

Open interface for writing.

This will create a new interface instance of the given type. The result can be casted to the appropriate type. This will only succeed if there is not already a writer for the given interface type/id!

Parameters
typetype of the interface
identifieridentifier of the interface
ownername of entity which opened this interface. If using the BlackBoardAspect to access the blackboard leave this untouched unless you have a good reason.
Returns
new fully initialized interface instance of requested type
Exceptions
OutOfMemoryExceptionthrown if there is not enough free space for the requested interface.
BlackBoardWriterActiveExceptionthrown if there is already a writing instance with the same type/id

Implements fawkes::BlackBoard.

Definition at line 112 of file local.cpp.

References fawkes::BlackBoardInterfaceManager::open_for_writing().

◆ open_multiple_for_reading()

std::list< Interface * > fawkes::LocalBlackBoard::open_multiple_for_reading ( const char *  type_pattern,
const char *  id_pattern = "*",
const char *  owner = NULL 
)
virtual

Open multiple interfaces for reading.

This will create interface instances for currently registered interfaces of the given type that match the given ID pattern. The result can be casted to the appropriate type.

Parameters
type_patternpattern of interface types to open, supports wildcards similar to filenames (*, ?, []), see "man fnmatch" for all supported.
id_patternpattern of interface IDs to open, supports wildcards similar to filenames (*, ?, []), see "man fnmatch" for all supported.
ownername of entity which opened this interface. If using the BlackBoardAspect to access the blackboard leave this untouched unless you have a good reason.
Returns
list of new fully initialized interface instances of requested type. You have to close all interfaces on your own when done with the list!

Implements fawkes::BlackBoard.

Definition at line 123 of file local.cpp.

References fawkes::BlackBoardInterfaceManager::open_multiple_for_reading().

◆ start_nethandler()

void fawkes::LocalBlackBoard::start_nethandler ( FawkesNetworkHub hub)
virtual

Start network handler.

This will start the network handler thread and register it with the given hub.

Parameters
hubhub to use and to register with

Definition at line 209 of file local.cpp.

References fawkes::Thread::start().

◆ try_aliveness_restore()

bool fawkes::LocalBlackBoard::try_aliveness_restore ( )
throw (
)
virtual

Try to restore the aliveness of the BlackBoard instance.

Note that even though the aliveness of the BlackBoard is restored single interfaces may still be invalid. That can for instance happen if a remote connection is re-established and a writer has been created during the downtime and an own writer instance of that very interface cannot be restored.

Returns
true if the aliveness could be restored and the BlackBoard is operational again, false otherwise.

Implements fawkes::BlackBoard.

Definition at line 164 of file local.cpp.


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