BBLogReplayThread Class Reference

BlackBoard log Replay thread. More...

#include <logreplay_thread.h>

Inheritance diagram for BBLogReplayThread:

[legend]
List of all members.

Public Member Functions

 BBLogReplayThread (const char *logfile_name, const char *logdir, const char *scenario, float grace_period, bool loop_replay, bool non_blocking=false, const char *thread_name="BBLogReplayThread", fawkes::Thread::OpMode th_opmode=Thread::OPMODE_CONTINUOUS)
 Constructor.
virtual ~BBLogReplayThread ()
 Destructor.
virtual void init ()
 Initialize the thread.
virtual void finalize ()
 Finalize the thread.
virtual void loop ()
 Code to execute in the thread.
virtual void once ()
 Execute an action exactly once.

Protected Member Functions

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

Detailed Description

BlackBoard log Replay thread.

Writes the data of the logfile into a blackboard interface, considering the time-step differences between the data.

Author:
Masrur Doostdar

Tim Niemueller

Definition at line 44 of file logreplay_thread.h.


Constructor & Destructor Documentation

BBLogReplayThread::BBLogReplayThread ( const char *  logfile_name,
const char *  logdir,
const char *  scenario,
float  grace_period,
bool  loop_replay,
bool  non_blocking = false,
const char *  thread_name = "BBLogReplayThread",
fawkes::Thread::OpMode  th_opmode = Thread::OPMODE_CONTINUOUS 
)

Constructor.

Parameters:
logfile_name filename of the log to be replayed
logdir directory containing the logfile
scenario ID of the log scenario
grace_period time in seconds that desired offset and loop offset may diverge to still write the new data
loop_replay specifies if the replay should be looped
non_blocking do not block the main loop if not enough time has elapsed to replay new data but just wait for the next cycle. This is ignored in continuous thread mode as it could cause busy waiting.
thread_name initial thread name
th_opmode thread operation mode

Definition at line 73 of file logreplay_thread.cpp.

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

BBLogReplayThread::~BBLogReplayThread (  )  [virtual]

Destructor.

Definition at line 102 of file logreplay_thread.cpp.


Member Function Documentation

void BBLogReplayThread::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:
Exception thrown if prepare_finalize() has not been called.
See also:
prepare_finalize()

cancel_finalize()

Reimplemented from fawkes::Thread.

Definition at line 150 of file logreplay_thread.cpp.

References fawkes::BlackBoardAspect::blackboard, and fawkes::BlackBoard::close().

Referenced by init().

void BBLogReplayThread::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 113 of file logreplay_thread.cpp.

References fawkes::BlackBoardAspect::blackboard, finalize(), BBLogFile::has_next(), BBLogFile::interface_id(), BBLogFile::interface_type(), fawkes::Logger::log_info(), fawkes::LoggingAspect::logger, fawkes::Thread::name(), fawkes::BlackBoard::open_for_writing(), and BBLogFile::set_interface().

void BBLogReplayThread::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 174 of file logreplay_thread.cpp.

References BBLogFile::entry_offset(), BBLogFile::has_next(), fawkes::Time::in_sec(), fawkes::Logger::log_info(), fawkes::LoggingAspect::logger, fawkes::Thread::name(), fawkes::Thread::opmode(), fawkes::Thread::OPMODE_CONTINUOUS, BBLogFile::read_next(), BBLogFile::rewind(), fawkes::Time::stamp(), fawkes::WaitCondition::wait(), fawkes::Time::wait(), and fawkes::Interface::write().

void BBLogReplayThread::once (  )  [virtual]

Execute an action exactly once.

This code is executed once and only once right after the thread is started before loop() is called. This is useful if you want to implement an one-shot background job. Just implement once() and leave once() untouched. Start the thread and detach it and it will just do its job and then die automatically. If you use set_delete_on_exit(true) even the Thread instance will be automatically deleted.

Reimplemented from fawkes::Thread.

Definition at line 159 of file logreplay_thread.cpp.

References BBLogFile::entry_offset(), BBLogFile::has_next(), BBLogFile::read_next(), fawkes::Time::stamp(), and fawkes::Interface::write().

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

Stub to see name in backtrace for easier debugging.

See also:
Thread::run()

Reimplemented from fawkes::Thread.

Reimplemented in BBLogReplayBlockedTimingThread.

Definition at line 68 of file logreplay_thread.h.


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