Fawkes API  Fawkes Development Version
fawkes::FawkesTimingThread Class Reference

Thread to control the main loop timing. More...

#include <>>

Inheritance diagram for fawkes::FawkesTimingThread:

Public Member Functions

virtual void init ()
 Initialize. More...
 
virtual void loop ()
 Thread loop. More...
 
virtual void finalize ()
 Finalize the thread. More...
 
- Public Member Functions inherited from fawkes::Thread
virtual ~Thread ()
 Virtual destructor. More...
 
bool prepare_finalize ()
 Prepare finalization. More...
 
virtual bool prepare_finalize_user ()
 Prepare finalization user implementation. More...
 
void cancel_finalize ()
 Cancel finalization. More...
 
void start (bool wait=true)
 Call this method to start the thread. More...
 
void cancel ()
 Cancel a thread. More...
 
void join ()
 Join the thread. More...
 
void detach ()
 Detach the thread. More...
 
void kill (int sig)
 Send signal to a thread. More...
 
bool operator== (const Thread &thread)
 Check if two threads are the same. More...
 
void wakeup ()
 Wake up thread. More...
 
void wakeup (Barrier *barrier)
 Wake up thread and wait for barrier afterwards. More...
 
void wait_loop_done ()
 Wait for the current loop iteration to finish. More...
 
OpMode opmode () const
 Get operation mode. More...
 
pthread_t thread_id () const
 Get ID of thread. More...
 
bool started () const
 Check if thread has been started. More...
 
bool cancelled () const
 Check if thread has been cancelled. More...
 
bool detached () const
 Check if thread has been detached. More...
 
bool running () const
 Check if the thread is running. More...
 
bool waiting () const
 Check if thread is currently waiting for wakeup. More...
 
const char * name () const
 Get name of thread. More...
 
void set_flags (uint32_t flags)
 Set all flags in one go. More...
 
void set_flag (uint32_t flag)
 Set flag for the thread. More...
 
void unset_flag (uint32_t flag)
 Unset flag. More...
 
bool flagged_bad () const
 Check if FLAG_BAD was set. More...
 
void set_delete_on_exit (bool del)
 Set whether the thread should be deleted on exit. More...
 
void set_prepfin_hold (bool hold)
 Hold prepare_finalize(). More...
 
void add_notification_listener (ThreadNotificationListener *notification_listener)
 Add notification listener. More...
 
void remove_notification_listener (ThreadNotificationListener *notification_listener)
 Remove notification listener. More...
 
void notify_of_failed_init ()
 Notify of failed init. More...
 
void add_loop_listener (ThreadLoopListener *loop_listener)
 Add loop listener. More...
 
void remove_loop_listener (ThreadLoopListener *loop_listener)
 Remove loop listener. More...
 
- Public Member Functions inherited from fawkes::SyncPointManagerAspect
 SyncPointManagerAspect ()
 Constructor. More...
 
void init_SyncPointManagerAspect (SyncPointManager *syncpoint_manager)
 Init SyncPointManager aspect. More...
 
- Public Member Functions inherited from fawkes::Aspect
const std::list< const char * > & get_aspects () const
 Get list of aspect names attached to a aspected thread. More...
 
- Public Member Functions inherited from fawkes::ConfigurableAspect
 ConfigurableAspect ()
 Constructor. More...
 
virtual ~ConfigurableAspect ()
 Virtual empty Destructor. More...
 
void init_ConfigurableAspect (Configuration *config)
 Set the configuration It is guaranteed that this is called for a configurable thread before Thread::start() is called (when running regularly inside Fawkes). More...
 
- Public Member Functions inherited from fawkes::LoggingAspect
 LoggingAspect ()
 Constructor. More...
 
virtual ~LoggingAspect ()
 Virtual empty Destructor. More...
 
void init_LoggingAspect (Logger *logger)
 Set the logger. More...
 

Additional Inherited Members

- Public Types inherited from fawkes::Thread
enum  OpMode { OPMODE_CONTINUOUS , OPMODE_WAITFORWAKEUP }
 Thread operation mode. More...
 
enum  CancelState { CANCEL_ENABLED , CANCEL_DISABLED }
 Cancel state. More...
 
- Static Public Member Functions inherited from fawkes::Thread
static Threadcurrent_thread ()
 Get the Thread instance of the currently running thread. More...
 
static Threadcurrent_thread_noexc () noexcept
 Similar to current_thread, but does never throw an exception. More...
 
static pthread_t current_thread_id ()
 Get the ID of the currently running thread. More...
 
static std::string current_thread_name ()
 Get the name of the current thread. More...
 
static void current_thread_name (const std::string &thread_name)
 Set the name of the current thread. More...
 
static void init_main ()
 Initialize Thread wrapper instance for main thread. More...
 
static void destroy_main ()
 Destroy main thread wrapper instance. More...
 
static void set_cancel_state (CancelState new_state, CancelState *old_state=0)
 Set the cancel state of the current thread. More...
 
- Static Public Attributes inherited from fawkes::Thread
static const unsigned int FLAG_BAD = 0x00000001
 Standard thread flag: "thread is bad". More...
 
- Protected Member Functions inherited from fawkes::Thread
 Thread (const char *name)
 Constructor. More...
 
 Thread (const char *name, OpMode op_mode)
 Constructor. More...
 
void exit ()
 Exit the thread. More...
 
void test_cancel ()
 Set cancellation point. More...
 
void yield ()
 Yield the processor to another thread or process. More...
 
virtual void run ()
 Code to execute in the thread. More...
 
void set_opmode (OpMode op_mode)
 Set operation mode. More...
 
void set_prepfin_conc_loop (bool concurrent=true)
 Set concurrent execution of prepare_finalize() and loop(). More...
 
void set_coalesce_wakeups (bool coalesce=true)
 Set wakeup coalescing. More...
 
void set_name (const char *format,...)
 Set name of thread. More...
 
virtual void once ()
 Execute an action exactly once. More...
 
bool wakeup_pending ()
 Check if wakeups are pending. More...
 
- Protected Member Functions inherited from fawkes::Aspect
void add_aspect (const char *name)
 Add an aspect to a thread. More...
 
- Protected Attributes inherited from fawkes::Thread
bool finalize_prepared
 True if prepare_finalize() has been called and was not stopped with a cancel_finalize(), false otherwise. More...
 
Mutexloop_mutex
 Mutex that is used to protect a call to loop(). More...
 
Mutexloopinterrupt_antistarve_mutex
 Mutex to avoid starvation when trying to lock loop_mutex. More...
 
- Protected Attributes inherited from fawkes::SyncPointManagerAspect
SyncPointManagersyncpoint_manager
 This is the SyncPointManager instance you can use to manage syncpoints. More...
 
- Protected Attributes inherited from fawkes::ConfigurableAspect
Configurationconfig
 This is the Configuration member used to access the configuration. More...
 
- Protected Attributes inherited from fawkes::LoggingAspect
Loggerlogger
 This is the Logger member used to access the logger. More...
 

Detailed Description

Thread to control the main loop timing.

This thread uses the preloop and postloop SyncPoints to control the timing of the main loop. It waits for the preloop SyncPoint at the beginning of the main loop and emits the postloop SyncPoint at the end of the loop. If the loop time is less than the desired loop time, the thread waits before releasing the postloop SyncPoint. If the loop time is longer than the maximum loop time, a warning is printed.

Definition at line 33 of file timing_thread.h.

Member Function Documentation

◆ finalize()

void fawkes::FawkesTimingThread::finalize ( )
virtual

Finalize the thread.

Release all SyncPoints and do other cleanup.

Reimplemented from fawkes::Thread.

Definition at line 130 of file timing_thread.cpp.

References fawkes::SyncPointManager::release_syncpoint().

◆ init()

void fawkes::FawkesTimingThread::init ( )
virtual

Initialize.

Get the pre- and postloop SyncPoints and read all relevant config values.

Reimplemented from fawkes::Thread.

Definition at line 46 of file timing_thread.cpp.

References fawkes::Configuration::get_bool(), fawkes::SyncPointManager::get_syncpoint(), fawkes::Configuration::get_uint(), fawkes::MultiLogger::log_debug(), and fawkes::MultiLogger::log_info().

◆ loop()

void fawkes::FawkesTimingThread::loop ( )
virtual

Thread loop.

This loop runs parallel to the main loop. At the beginning of the main loop, it waits for the preloop SyncPoint. At the end of the main loop, it emits the postloop SyncPoint.

Reimplemented from fawkes::Thread.

Definition at line 87 of file timing_thread.cpp.

References fawkes::MultiLogger::log_warn().


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