Public Member Functions | Protected Member Functions

BBLoggerThread Class Reference

BlackBoard logger thread. More...

#include "log_thread.h"

Inheritance diagram for BBLoggerThread:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 BBLoggerThread (const char *iface_uid, const char *logdir, bool buffering, bool flushing, const char *scenario, fawkes::Time *start_time)
 Constructor.
virtual ~BBLoggerThread ()
 Destructor.
const char * get_filename () const
 Get filename.
void set_threadlist (fawkes::ThreadList &thread_list)
 Set threadlist and master status.
void set_enabled (bool enabled)
 Enable or disable logging.
virtual void init ()
virtual void finalize ()
virtual void loop ()
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.
virtual void bb_interface_writer_added (fawkes::Interface *interface, unsigned int instance_serial) throw ()
 A writing instance has been opened for a watched interface.
virtual void bb_interface_writer_removed (fawkes::Interface *interface, unsigned int instance_serial) throw ()
 A writing instance has been closed for a watched interface.

Protected Member Functions

virtual void run ()
 Stub to see name in backtrace for easier debugging.

Detailed Description

BlackBoard logger thread.

One instance of this thread handles logging of one specific interface. The plugin will spawn as many threads as there are interfaces to log. This allows for maximum concurrency of the writers and avoids a serialization bottle neck. The log thread can operate in buffering mode. If this mode is disabled, the data is written to the file within the blackboard data changed event, and thus the writing operation can slow down the overall system, but memory requirements are low. This is useful if a lot of data is written or if the storage device is slow. If the mode is enabled, during the event the BB data will be copied into another memory segment and the thread will be woken up. Once the thread is running it stores all of the BB data segments bufferd up to then. The interface listener listens for events for a particular interface and then writes the changes to the file.

Author:
Tim Niemueller

Definition at line 46 of file log_thread.h.


Constructor & Destructor Documentation

BBLoggerThread::BBLoggerThread ( const char *  iface_uid,
const char *  logdir,
bool  buffering,
bool  flushing,
const char *  scenario,
fawkes::Time start_time 
)

Constructor.

Parameters:
iface_uid interface UID which to log
logdir directory to store config files, must exist
buffering enable log buffering?
flushing true to flush after each written chunk
scenario ID of the log scenario
start_time time to use as start time for the log

Definition at line 75 of file log_thread.cpp.

References fawkes::Time::get_timeval(), fawkes::Thread::set_coalesce_wakeups(), and fawkes::Thread::set_name().

BBLoggerThread::~BBLoggerThread (  )  [virtual]

Destructor.

Definition at line 114 of file log_thread.cpp.


Member Function Documentation

void BBLoggerThread::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 380 of file log_thread.cpp.

bool BBLoggerThread::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 351 of file log_thread.cpp.

References set_enabled().

void BBLoggerThread::bb_interface_writer_added ( fawkes::Interface interface,
unsigned int  instance_serial 
) throw () [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.

Parameters:
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 407 of file log_thread.cpp.

void BBLoggerThread::bb_interface_writer_removed ( fawkes::Interface interface,
unsigned int  instance_serial 
) throw () [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.

Parameters:
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 414 of file log_thread.cpp.

const char * BBLoggerThread::get_filename (  )  const

Get filename.

Returns:
file name, valid after object instantiated, but before init() does not mean that the file has been or can actually be opened

Definition at line 222 of file log_thread.cpp.

Referenced by BlackBoardLoggerPlugin::BlackBoardLoggerPlugin().

virtual void BBLoggerThread::run (  )  [inline, protected, virtual]

Stub to see name in backtrace for easier debugging.

See also:
Thread::run()

Definition at line 76 of file log_thread.h.

void BBLoggerThread::set_enabled ( bool  enabled  ) 

Enable or disable logging.

Parameters:
enabled true to enable logging, false to disable

Definition at line 232 of file log_thread.cpp.

References fawkes::Logger::log_info(), fawkes::LoggingAspect::logger, and fawkes::Thread::name().

Referenced by bb_interface_message_received().

void BBLoggerThread::set_threadlist ( fawkes::ThreadList thread_list  ) 

Set threadlist and master status.

This copies the thread list and sets this thread as master thread. If you intend to use this method you must do so before the thread is initialized. You may only ever declare one thread as master.

Parameters:
thread_list list of threads to notify on enable/disable events

Definition at line 256 of file log_thread.cpp.

Referenced by BlackBoardLoggerPlugin::BlackBoardLoggerPlugin().


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