Fawkes API  Fawkes Development Version
BlackBoardSynchronizationThread Class Reference

Thread to synchronize two BlackBoards. More...

#include "sync_thread.h"

Inheritance diagram for BlackBoardSynchronizationThread:

List of all members.

Classes

struct  combo_t
 Interface combo struct. More...
class  InterfaceInfo

Public Member Functions

 BlackBoardSynchronizationThread (std::string &bbsync_cfg_prefix, std::string &peer_cfg_prefix, std::string &peer)
 Constructor.
virtual ~BlackBoardSynchronizationThread ()
 Destructor.
virtual void init ()
 Initialize the thread.
virtual void loop ()
 Code to execute in the thread.
virtual void finalize ()
 Finalize the thread.
void writer_added (fawkes::Interface *interface) throw ()
 A writer has been added for an interface.
void writer_removed (fawkes::Interface *interface) throw ()
 A writer has been removed for an interface.

Protected Member Functions

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

Detailed Description

Thread to synchronize two BlackBoards.

Author:
Tim Niemueller

Constructor & Destructor Documentation

BlackBoardSynchronizationThread::BlackBoardSynchronizationThread ( std::string bbsync_cfg_prefix,
std::string peer_cfg_prefix,
std::string peer 
)

Constructor.

Parameters:
bbsync_cfg_prefixConfiguration prefix for the whole bbsync plugin
peer_cfg_prefixThe configuration prefix for the peer this sync thread has been created for.
peername of the peer configuration for this thread

Definition at line 45 of file sync_thread.cpp.

References fawkes::Thread::set_name(), and fawkes::Thread::set_prepfin_conc_loop().

BlackBoardSynchronizationThread::~BlackBoardSynchronizationThread ( ) [virtual]

Destructor.

Definition at line 62 of file sync_thread.cpp.


Member Function Documentation

void BlackBoardSynchronizationThread::finalize ( ) [virtual]

Finalize the thread.

This method is executed just before the thread is canceled and destroyed. It is always preceeded by a call to prepare_finalize(). If this is not the case this is a failure. The condition can be checked with the boolean variable finalize_prepared.

This method is meant to be used in conjunction with aspects and to cover thread inter-dependencies. This routine MUST bring the thread into a safe state such that it may be canceled and destroyed afterwards. If there is any reason that this cannot happen make your prepare_finalize() reports so.

This method is called by the thread manager just before the thread is being cancelled. Here you can do whatever steps are necessary just before the thread is cancelled. Note that you thread is still running and might be in the middle of a loop, so it is not a good place to give up on all resources used. Mind segmentation faults that could happen. Protect the area with a mutex that you lock at the beginning of your loop and free in the end, and that you lock at the beginning of finalize and then never unlock. Also not that the finalization may be canceled afterwards. The next thing that happens is that either the thread is canceled and destroyed or that the finalization is canceled and the thread has to run again.

Finalize is called on a thread just before it is deleted. It is guaranteed to be called on a fully initialized thread (if no exception is thrown in init()) (this guarantee holds in the Fawkes framework).

The default implementation does nothing besides throwing an exception if prepare_finalize() has not been called.

Exceptions:
Exceptionthrown if prepare_finalize() has not been called.
See also:
prepare_finalize()
cancel_finalize()

Reimplemented from fawkes::Thread.

Definition at line 110 of file sync_thread.cpp.

void BlackBoardSynchronizationThread::init ( ) [virtual]

Initialize the thread.

This method is meant to be used in conjunction with aspects. Some parts of the initialization may only happen after some aspect of the thread has been initialized. Implement the init method with these actions. It is guaranteed to be called just after all aspects have been initialized and only once in the lifetime of the thread. Throw an exception if any problem occurs and the thread should not run.

Just because your init() routine suceeds and everything looks fine for this thread does not automatically imply that it will run. If it belongs to a group of threads in a ThreadList and any of the other threads fail to initialize then no thread from this group is run and thus this thread will never run. In that situation finalize() is called for this very instance, prepare_finalize() however is not called.

See also:
Fawkes Thread Aspects

Reimplemented from fawkes::Thread.

Definition at line 67 of file sync_thread.cpp.

References fawkes::LoggingAspect::logger, fawkes::Logger::log_debug(), fawkes::Thread::name(), fawkes::ConfigurableAspect::config, fawkes::Configuration::get_string(), fawkes::Configuration::get_uint(), fawkes::Exception::append(), fawkes::Logger::log_warn(), and fawkes::ClockAspect::clock.

void BlackBoardSynchronizationThread::loop ( ) [virtual]

Code to execute in the thread.

Implement this method to hold the code you want to be executed continously. If you do not implement this method, the default is that the thread will exit. This is useful if you choose to only implement once().

Reimplemented from fawkes::Thread.

Definition at line 125 of file sync_thread.cpp.

References fawkes::TimeWait::mark_start(), and fawkes::TimeWait::wait_systime().

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

Stub to see name in backtrace for easier debugging.

See also:
Thread::run()

Reimplemented from fawkes::Thread.

Definition at line 64 of file sync_thread.h.


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