tp::Timeout struct

Specifies a timeout duration for wait operations.

Public static functions

static auto Indefinite() -> Timeout constexpr
Returns a tp::Timeout value that will wait indefinitely.
static auto Milliseconds(float milliseconds) -> Timeout
Returns a tp::Timeout using a duration in milliseconds.
static auto NoWait() -> Timeout constexpr
Returns a tp::Timeout value that will not wait at all.
static auto Seconds(float seconds) -> Timeout
Returns a tp::Timeout using a duration in seconds.

Constructors, destructors, conversion operators

Timeout(uint64_t nanoseconds) explicit constexpr

Public functions

auto isIndefinite() const -> bool
Returns true if the tp::Timeout will wait indefinitely.

Function documentation

static Timeout tp::Timeout::Milliseconds(float milliseconds)

Returns a tp::Timeout using a duration in milliseconds.

Parameters
milliseconds The wait duration in milliseconds.

static Timeout tp::Timeout::Seconds(float seconds)

Returns a tp::Timeout using a duration in seconds.

Parameters
seconds The wait duration in seconds.

tp::Timeout::Timeout(uint64_t nanoseconds) explicit constexpr

Parameters
nanoseconds Raw wait duration in nanoseconds.