profinet::MaxTimeout Class Reference

Time-limited-operation helper, mirroring util.py's MaxTimeout context manager. More...

#include <util.h>

Collaboration diagram for profinet::MaxTimeout:

Public Member Functions
	MaxTimeout (std::chrono::duration< double > seconds)
	Start a countdown of the given duration.
bool	TimedOut () const
	Whether the countdown has elapsed.
std::chrono::duration< double >	Remaining () const
	Time left before the countdown elapses.

Private Attributes
std::chrono::steady_clock::time_point	dieAfter
	Time point at which TimedOut() will start returning true.

Detailed Description

Time-limited-operation helper, mirroring util.py's MaxTimeout context manager.

Example:

MaxTimeout timer(std::chrono::seconds(10));
while (!timer.TimedOut()) { ... }

Definition at line 318 of file util.h.

Constructor & Destructor Documentation

MaxTimeout()

profinet::MaxTimeout::MaxTimeout ( std::chrono::duration< double >  seconds )

inlineexplicit

Start a countdown of the given duration.

Parameters

seconds

How long until TimedOut() returns true.

Definition at line 323 of file util.h.

Member Function Documentation

Remaining()

std::chrono::duration< double > profinet::MaxTimeout::Remaining ( ) const

inline

Time left before the countdown elapses.

Returns

The remaining duration, clamped to zero (never negative).

Definition at line 338 of file util.h.

References dieAfter.

TimedOut()

bool profinet::MaxTimeout::TimedOut ( ) const

inline

Whether the countdown has elapsed.

Returns

True if the configured duration has passed since construction.

Definition at line 331 of file util.h.

References dieAfter.

Member Data Documentation

dieAfter

std::chrono::steady_clock::time_point profinet::MaxTimeout::dieAfter

private

Time point at which TimedOut() will start returning true.

Definition at line 347 of file util.h.

Referenced by Remaining(), and TimedOut().

---

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

• include/profinet/util.h