Skip to content

Class hal::steady_clock_timeout

ClassList > hal > steady_clock_timeout

Timeout object based on hal::steady_clock .More...

  • #include <steady_clock.hpp>

Public Functions

Type Name
status operator() ()
Call this object to check if it has timed out.
steady_clock_timeout & operator= (const steady_clock_timeout & p_timeout) = default
Assign construct a new counter timeout object.
steady_clock_timeout & operator= (steady_clock_timeout && p_timeout) = default
Move assign construct a new counter timeout object.
steady_clock_timeout (const steady_clock_timeout & p_timeout) = default
Construct a new counter timeout object.
steady_clock_timeout (steady_clock_timeout && p_timeout) = default
Construct a new counter timeout object.

Public Static Functions

Type Name
steady_clock_timeout create (hal::steady_clock & p_steady_clock, hal::time_duration p_duration)
Create a steady_clock_timeout .

Detailed Description

Do not use this class directly. Use hal::create_timeout(hal::steady_clock&) instead of instantiating this class directly.

Public Functions Documentation

function operator()

Call this object to check if it has timed out. 

status hal::steady_clock_timeout::operator() ()

Returns:

status - success or failure

Exception:

  • std::errc::timed_out - if the timeout time has been exceeded.

function operator=

Assign construct a new counter timeout object. 

steady_clock_timeout & hal::steady_clock_timeout::operator= (
    const steady_clock_timeout & p_timeout
) = default

Parameters:

Returns:

steady_clock_timeout&

function operator=

Move assign construct a new counter timeout object. 

steady_clock_timeout & hal::steady_clock_timeout::operator= (
    steady_clock_timeout && p_timeout
) = default

Parameters:

Returns:

steady_clock_timeout&

function steady_clock_timeout [1/3]

Construct a new counter timeout object. 

hal::steady_clock_timeout::steady_clock_timeout (
    const steady_clock_timeout & p_timeout
) = default

Parameters:

function steady_clock_timeout [2/3]

Construct a new counter timeout object. 

hal::steady_clock_timeout::steady_clock_timeout (
    steady_clock_timeout && p_timeout
) = default

Parameters:

Public Static Functions Documentation

function create

Create a steady_clock_timeout . 

static steady_clock_timeout hal::steady_clock_timeout::create (
    hal::steady_clock & p_steady_clock,
    hal::time_duration p_duration
)

Returns:

steady_clock_timeout - steady_clock_timeout object

The documentation for this class was generated from the following file libraries/include/libhal-util/steady_clock.hpp