An abstraction for a periodic thread. More...

#include <yarp/os/PeriodicThread.h>

Inheritance diagram for yarp::os::PeriodicThread:

Detailed Description

An abstraction for a periodic thread.

Examples:: os/ratethread.cpp.

Definition at line 24 of file PeriodicThread.h.

Classes
class	Private

Public Member Functions
	PeriodicThread (double period, ShouldUseSystemClock useSystemClock=ShouldUseSystemClock::No)
	Constructor. More...

virtual	~PeriodicThread ()

bool	start ()
	Call this to start the thread. More...

void	step ()
	Call this to "step" the thread rather than starting it. More...

void	stop ()
	Call this to stop the thread, this call blocks until the thread is terminated (and releaseThread() called). More...

void	askToStop ()
	Stop the thread. More...

bool	isRunning () const
	Returns true when the thread is started, false otherwise. More...

bool	isSuspended () const
	Returns true when the thread is suspended, false otherwise. More...

bool	setPeriod (double period)
	Set the (new) period of the thread. More...

double	getPeriod () const
	Return the current period of the thread. More...

void	suspend ()
	Suspend the thread, the thread keeps running by doLoop is never executed. More...

void	resume ()
	Resume the thread if previously suspended. More...

void	resetStat ()
	Reset thread statistics. More...

double	getEstimatedPeriod () const
	Return estimated period since last reset. More...

void	getEstimatedPeriod (double &av, double &std) const
	Return estimated period since last reset. More...

unsigned int	getIterations () const
	Return the number of iterations performed since last reset. More...

double	getEstimatedUsed () const
	Return the estimated duration of the run() function since last reset. More...

void	getEstimatedUsed (double &av, double &std) const
	Return estimated duration of the run() function since last reset. More...

int	setPriority (int priority, int policy=-1)
	Set the priority and scheduling policy of the thread, if the OS supports that. More...

int	getPriority () const
	Query the current priority of the thread, if the OS supports that. More...

int	getPolicy () const
	Query the current scheduling policy of the thread, if the OS supports that. More...

Protected Member Functions
virtual bool	threadInit ()
	Initialization method. More...

virtual void	threadRelease ()
	Release method. More...

virtual void	run ()=0
	Loop function. More...

virtual void	beforeStart ()
	Called just before a new thread starts. More...

virtual void	afterStart (bool success)
	Called just after a new thread starts (or fails to start), this is executed by the same thread that calls start(). More...

Constructor & Destructor Documentation

◆ PeriodicThread()

PeriodicThread::PeriodicThread	(	double	period,
		ShouldUseSystemClock	useSystemClock = `ShouldUseSystemClock::No`
	)

explicit

Constructor.

Thread begins in a dormant state. Call PeriodicThread::start to get things going.

Parameters

period	The period in seconds [sec] between successive calls to the PeriodicThread::run method (remember you need to call PeriodicThread::start first before anything happens)
useSystemClock	whether the thread should always use the system clock, or depend on the current configuration of the network.

Definition at line 272 of file PeriodicThread.cpp.

◆ ~PeriodicThread()

PeriodicThread::~PeriodicThread ( )

virtual

Definition at line 277 of file PeriodicThread.cpp.

Member Function Documentation

◆ afterStart()

void PeriodicThread::afterStart ( bool success )

protectedvirtual

Called just after a new thread starts (or fails to start), this is executed by the same thread that calls start().

Parameters

success true iff the new thread started successfully.

Reimplemented in yarp::os::RateThreadWrapper, and yarp::os::RateThread.

Definition at line 375 of file PeriodicThread.cpp.

◆ askToStop()

void PeriodicThread::askToStop ( )

Stop the thread.

Like stop but it does not call join, safe to be called from run().

Definition at line 302 of file PeriodicThread.cpp.

◆ beforeStart()

void PeriodicThread::beforeStart ( )

protectedvirtual

Called just before a new thread starts.

This method is executed by the same thread that calls start().

Reimplemented in yarp::os::RateThreadWrapper, and yarp::os::RateThread.

Definition at line 371 of file PeriodicThread.cpp.

◆ getEstimatedPeriod() [1/2]

double PeriodicThread::getEstimatedPeriod ( ) const

Return estimated period since last reset.

Definition at line 337 of file PeriodicThread.cpp.

◆ getEstimatedPeriod() [2/2]

void PeriodicThread::getEstimatedPeriod	(	double &	av,
		double &	std
	)		const

Return estimated period since last reset.

Parameters

[out]	av	average value
[out]	std	standard deviation

Definition at line 347 of file PeriodicThread.cpp.

◆ getEstimatedUsed() [1/2]

double PeriodicThread::getEstimatedUsed ( ) const

Return the estimated duration of the run() function since last reset.

Definition at line 342 of file PeriodicThread.cpp.

◆ getEstimatedUsed() [2/2]

void PeriodicThread::getEstimatedUsed	(	double &	av,
		double &	std
	)		const

Return estimated duration of the run() function since last reset.

Parameters

[out]	av	average value
[out]	std	standard deviation

Definition at line 352 of file PeriodicThread.cpp.

◆ getIterations()

unsigned int PeriodicThread::getIterations ( ) const

Return the number of iterations performed since last reset.

Definition at line 332 of file PeriodicThread.cpp.

◆ getPeriod()

double PeriodicThread::getPeriod ( ) const

Return the current period of the thread.

Returns: thread current period [sec].

Definition at line 287 of file PeriodicThread.cpp.

◆ getPolicy()

int PeriodicThread::getPolicy ( ) const

Query the current scheduling policy of the thread, if the OS supports that.

Returns: the scheduling policy of the thread.

Definition at line 390 of file PeriodicThread.cpp.

◆ getPriority()

int PeriodicThread::getPriority ( ) const

Query the current priority of the thread, if the OS supports that.

Returns: the priority of the thread.

Definition at line 385 of file PeriodicThread.cpp.

◆ isRunning()

bool PeriodicThread::isRunning ( ) const

Returns true when the thread is started, false otherwise.

Definition at line 317 of file PeriodicThread.cpp.

◆ isSuspended()

bool PeriodicThread::isSuspended ( ) const

Returns true when the thread is suspended, false otherwise.

Definition at line 292 of file PeriodicThread.cpp.

◆ resetStat()

void PeriodicThread::resetStat ( )

Reset thread statistics.

Definition at line 357 of file PeriodicThread.cpp.

◆ resume()

void PeriodicThread::resume ( )

Resume the thread if previously suspended.

Definition at line 327 of file PeriodicThread.cpp.

◆ run()

virtual void yarp::os::PeriodicThread::run ( )

protectedpure virtual

Loop function.

This is the thread itself. The thread calls the run() function every <period> ms. At the end of each run, the thread will sleep the amounth of time required, taking into account the time spent inside the loop function. Example: requested period is 10ms, the run() function take 3ms to be executed, the thread will sleep for 7ms.

Note: after each run is completed, the thread will call a yield() in order to facilitate other threads to run.

Implemented in FakeMotionControl, BoschIMU, yarp::dev::ControlBoardWrapper, yarp::dev::ServerGrabber, yarp::dev::IJoypadEventDriven, yarp::os::RateThreadWrapper, yarp::dev::RGBDSensorWrapper, RpLidar, yarp::dev::AnalogWrapper, yarp::os::RateThread, FrameTransformClient, FakeLaser, BatteryWrapper, laserHokuyo, RpLidar2, MonitorTrigger, yarp::dev::JoypadControlServer, LaserFromDepth, MultipleAnalogSensorsServer, yarp::dev::OVRHeadset, FrameTransformServer, AudioPlayerWrapper, Rangefinder2DWrapper, Localization2DServer, AudioRecorderWrapper, navigation2DServer, FakeAnalogSensor, FakeBattery, TextureBattery, PriorityDebugThread, fakeLocalizerThread, yarp::dev::JoypadControlWatchdog, and fakeNavigationThread.

◆ setPeriod()

bool PeriodicThread::setPeriod ( double period )

Set the (new) period of the thread.

Parameters

period the period [sec]

Returns: true.

Definition at line 282 of file PeriodicThread.cpp.

◆ setPriority()

int PeriodicThread::setPriority	(	int	priority,
		int	policy = `-1`
	)

Set the priority and scheduling policy of the thread, if the OS supports that.

Parameters

priority	the new priority of the thread.
policy	the scheduling policy of the thread

Returns: -1 if the priority cannot be set.

Note: The thread policy is highly OS dependent and a right combination of priority and policy should be used. In some platform changing thread priorities is subject to having the right permission. For example, the following combinations are supported on most Linux platforms: SCHED_OTHER : policy=0, priority=[0 .. 0] SCHED_FIFO : policy=1, priority=[1 .. 99] SCHED_RR : policy=2, priority=[1 .. 99]

Definition at line 380 of file PeriodicThread.cpp.

◆ start()

bool PeriodicThread::start ( )

Call this to start the thread.

Blocks until initThread() is executed.

Definition at line 312 of file PeriodicThread.cpp.

◆ step()

void PeriodicThread::step ( )

Call this to "step" the thread rather than starting it.

This will execute at most one call to doLoop before returning.

Definition at line 307 of file PeriodicThread.cpp.

◆ stop()

void PeriodicThread::stop ( )

Call this to stop the thread, this call blocks until the thread is terminated (and releaseThread() called).

Actually calls join. This will deadlock if called from run(), use askToStop() instead.

Definition at line 297 of file PeriodicThread.cpp.

◆ suspend()

void PeriodicThread::suspend ( )

Suspend the thread, the thread keeps running by doLoop is never executed.

Definition at line 322 of file PeriodicThread.cpp.

◆ threadInit()

bool PeriodicThread::threadInit ( )

protectedvirtual

Initialization method.

The thread executes this function when it starts and before "run". This is a good place to perform initialization tasks that need to be done by the thread itself (device drivers initialization, memory allocation etc). If the function returns false the thread quits and never calls "run". The return value of threadInit() is notified to the class and passed as a parameter to afterStart(). Note that afterStart() is called by the same thread that is executing the "start" method.

Reimplemented in BoschIMU, yarp::dev::IJoypadEventDriven, yarp::dev::ServerGrabber, yarp::os::RateThreadWrapper, yarp::dev::RGBDSensorWrapper, FakeMotionControl, RpLidar, yarp::dev::AnalogWrapper, yarp::os::RateThread, FrameTransformClient, FakeLaser, BatteryWrapper, laserHokuyo, RpLidar2, yarp::dev::JoypadControlServer, LaserFromDepth, yarp::dev::OVRHeadset, FrameTransformServer, AudioPlayerWrapper, Rangefinder2DWrapper, AudioRecorderWrapper, FakeAnalogSensor, PriorityDebugThread, FakeBattery, fakeLocalizerThread, and fakeNavigationThread.

Definition at line 362 of file PeriodicThread.cpp.

◆ threadRelease()

void PeriodicThread::threadRelease ( )

protectedvirtual

Release method.

The thread executes this function once when it exits, after the last "run". This is a good place to release resources that were initialized in threadInit() (release memory, and device driver resources).

Reimplemented in BoschIMU, yarp::dev::ServerGrabber, yarp::os::RateThreadWrapper, yarp::dev::RGBDSensorWrapper, FakeMotionControl, RpLidar, yarp::dev::AnalogWrapper, yarp::os::RateThread, FrameTransformClient, FakeLaser, BatteryWrapper, laserHokuyo, RpLidar2, yarp::dev::JoypadControlServer, LaserFromDepth, MultipleAnalogSensorsServer, yarp::dev::OVRHeadset, FrameTransformServer, AudioPlayerWrapper, Rangefinder2DWrapper, AudioRecorderWrapper, FakeAnalogSensor, PriorityDebugThread, FakeBattery, fakeLocalizerThread, and fakeNavigationThread.

Definition at line 367 of file PeriodicThread.cpp.

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

src/libYARP_OS/include/yarp/os/PeriodicThread.h
src/libYARP_OS/src/PeriodicThread.cpp

Detailed Description

Classes

Public Member Functions

Protected Member Functions

Constructor & Destructor Documentation

◆ PeriodicThread()

◆ ~PeriodicThread()

Member Function Documentation

◆ afterStart()

◆ askToStop()

◆ beforeStart()

◆ getEstimatedPeriod() [1/2]

◆ getEstimatedPeriod() [2/2]

◆ getEstimatedUsed() [1/2]

◆ getEstimatedUsed() [2/2]

◆ getIterations()

◆ getPeriod()

◆ getPolicy()

◆ getPriority()

◆ isRunning()

◆ isSuspended()

◆ resetStat()

◆ resume()

◆ run()

◆ setPeriod()

◆ setPriority()

◆ start()

◆ step()

◆ stop()

◆ suspend()

◆ threadInit()

◆ threadRelease()