RADLib
RADical C++ application framework
RADCore::RADDeadlineTimer Class Reference

Deadline helper for timeout loops and cancellation-aware waits. More...

#include <RADCore.h>

Public Member Functions

 RADDeadlineTimer ()=default
 Creates an expired deadline. More...
 
 RADDeadlineTimer (int64_t intervalMs)
 Creates a deadline intervalMs in the future. More...
 
bool isValid () const
 Returns true when this deadline has been configured. More...
 
bool hasExpired () const
 Returns true when the deadline has passed. More...
 
int64_t remainingMilliseconds () const
 Returns milliseconds remaining, or 0 when expired/invalid. More...
 

Detailed Description

Deadline helper for timeout loops and cancellation-aware waits.

Constructor & Destructor Documentation

◆ RADDeadlineTimer() [1/2]

RADCore::RADDeadlineTimer::RADDeadlineTimer ( )
default

Creates an expired deadline.

◆ RADDeadlineTimer() [2/2]

RADCore::RADDeadlineTimer::RADDeadlineTimer ( int64_t  intervalMs)
inlineexplicit

Creates a deadline intervalMs in the future.

Member Function Documentation

◆ hasExpired()

bool RADCore::RADDeadlineTimer::hasExpired ( ) const
inline

Returns true when the deadline has passed.

◆ isValid()

bool RADCore::RADDeadlineTimer::isValid ( ) const
inline

Returns true when this deadline has been configured.

◆ remainingMilliseconds()

int64_t RADCore::RADDeadlineTimer::remainingMilliseconds ( ) const
inline

Returns milliseconds remaining, or 0 when expired/invalid.


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