Fawkes API  Fawkes Development Version
fawkes::ThreadLoopListener Class Reference

Thread loop listener interface. More...

#include <>>

Inheritance diagram for fawkes::ThreadLoopListener:

Public Member Functions

virtual ~ThreadLoopListener ()
 Virtual empty destructor. More...
 
virtual void pre_loop (Thread *thread)
 This is called by the thread every time before loop() is called. More...
 
virtual void post_loop (Thread *thread)
 This is called by the thread every time after loop() returned. More...
 

Detailed Description

Thread loop listener interface.

A thread loop listener can be added to a thread to define pre and post loop tasks, which are executed before and after every loop.

Author
Till Hofmann

Definition at line 31 of file thread_loop_listener.h.

Constructor & Destructor Documentation

◆ ~ThreadLoopListener()

fawkes::ThreadLoopListener::~ThreadLoopListener ( )
virtual

Virtual empty destructor.

Definition at line 45 of file thread_loop_listener.cpp.

Member Function Documentation

◆ post_loop()

void fawkes::ThreadLoopListener::post_loop ( Thread thread)
virtual

This is called by the thread every time after loop() returned.

Empty stub for the post loop function of the loop listener.

Parameters
threadthread whose loop() just returned.

This function is called right after the loop of the thread with the aspect. Provide a stub such that not every derived class must implement the function.

Parameters
threadthread this loop listener belongs to

Reimplemented in fawkes::BlockedTimingLoopListener, and fawkes::SyncPointAspect.

Definition at line 65 of file thread_loop_listener.cpp.

◆ pre_loop()

void fawkes::ThreadLoopListener::pre_loop ( Thread thread)
virtual

This is called by the thread every time before loop() is called.

Empty stub for the pre loop function of the loop listener.

Parameters
threadthread whose loop() is will be called.

This function is called right before the loop of the thread with the aspect. Provide a stub such that not every derived class must implement the function.

Parameters
threadthread this loop listener belongs to

Reimplemented in fawkes::SyncPointAspect.

Definition at line 55 of file thread_loop_listener.cpp.


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