os::rtos::clock Class Reference

Generic clock. More...

#include <cmsis-plus/rtos/os.h>

Inheritance diagram for os::rtos::clock:

Public Types
Types & Constants
using	duration_t = port::clock::duration_t
	Type of variables holding clock durations.
using	timestamp_t = port::clock::timestamp_t
	Type of variables holding clock time stamps.
using	offset_t = port::clock::offset_t
	Type of variables holding clock offsets.

Public Member Functions
Constructors & Destructor
virtual	~clock ()
	Destruct the clock object instance.
Public Member Functions
virtual void	start (void)=0
	Start the clock.
virtual timestamp_t	now (void)
	Tell the current time, possibly adjusted for epoch.
timestamp_t	steady_now (void)
	Tell the current time since startup.
result_t	sleep_for (duration_t duration)
	Sleep for a relative duration.
virtual result_t	sleep_until (timestamp_t timestamp)
	Sleep until an absolute timestamp.
result_t	wait_for (duration_t timeout)
	Timed wait for an event.
timestamp_t	update_for_slept_time (duration_t duration)
	Increase the internal count after a deep sleep.
Public Member Functions
const char *	name (void) const
	Get object name.

Detailed Description

Generic clock.

Used as base class for all clocks.

Definition at line 58 of file os-clocks.h.

Constructor & Destructor Documentation

~clock()

os::rtos::clock::~clock ( )

virtual

Destruct the clock object instance.

Definition at line 145 of file os-clocks.cpp.

Member Function Documentation

name()

const char * os::rtos::internal::object_named::name ( void  ) const

inlineinherited

Get object name.

Parameters

None.

Returns

A null terminated string.

All objects return a non-null string; anonymous objects return "-".

Note

Can be invoked from Interrupt Service Routines.

Definition at line 759 of file os-decls.h.

now()

clock::timestamp_t os::rtos::clock::now ( void  )

virtual

Tell the current time, possibly adjusted for epoch.

Parameters

None.

Returns

The clock current timestamp (time units from startup plus the epoch offset).

Note

Can be invoked from Interrupt Service Routines.

Reimplemented in os::rtos::adjustable_clock, and os::rtos::clock_highres.

Definition at line 162 of file os-clocks.cpp.

sleep_for()

result_t os::rtos::clock::sleep_for

(

duration_t

duration

)

Sleep for a relative duration.

Parameters

[in]

duration

The number of clock units (ticks or seconds) to sleep.

Return values

ETIMEDOUT	The sleep lasted the entire duration.
EPERM	Cannot be invoked from an Interrupt Service Routines.
EINTR	The sleep was interrupted.

Warning

Cannot be invoked from Interrupt Service Routines.

Definition at line 190 of file os-clocks.cpp.

sleep_until()

result_t os::rtos::clock::sleep_until ( timestamp_t  timestamp )

virtual

Sleep until an absolute timestamp.

Parameters

[in]

timestamp

The absolute moment in time, in clock units.

Return values

ETIMEDOUT	The sleep lasted the entire duration.
EPERM	Cannot be invoked from an Interrupt Service Routines.
EINTR	The sleep was interrupted.

Warning

Cannot be invoked from Interrupt Service Routines.

Reimplemented in os::rtos::adjustable_clock.

Definition at line 240 of file os-clocks.cpp.

start()

void os::rtos::clock::start ( void  )

pure virtual

Start the clock.

Parameters

None.

Returns

Nothing.

For system clocks it is called from the system startup code.

Implemented in os::rtos::clock_systick, os::rtos::clock_rtc, and os::rtos::clock_highres.

Definition at line 154 of file os-clocks.cpp.

steady_now()

clock::timestamp_t os::rtos::clock::steady_now

(

void

)

Tell the current time since startup.

Parameters

None.

Returns

The clock current steady timestamp (time units from startup).

Note

Can be invoked from Interrupt Service Routines.

Definition at line 176 of file os-clocks.cpp.

update_for_slept_time()

clock::timestamp_t os::rtos::clock::update_for_slept_time

(

duration_t

duration

)

Increase the internal count after a deep sleep.

Parameters

duration

Number of ticks lost during sleep.

Returns

The clock current steady timestamp (time units from startup).

During deep sleep the interrupts used to count clock ticks are usually disabled and an external RTC is configured to wake-up the device, so a number of clock ticks are lost.

To keep the clocks accurate, it is recommended to sample the external RTC before entering deep sleep and again when the device is back to life, compute the time slept as difference, and use this function to update the internal clock counter.

Definition at line 329 of file os-clocks.cpp.

wait_for()

result_t os::rtos::clock::wait_for

(

duration_t

timeout

)

Timed wait for an event.

Parameters

[in]

timeout

The timeout in clock units.

Return values

result::ok	An event occurred before the timeout.
ETIMEDOUT	The wait lasted the entire duration.
EPERM	Cannot be invoked from an Interrupt Service Routines.
EINTR	The sleep was interrupted.

Warning

Cannot be invoked from Interrupt Service Routines.

Definition at line 279 of file os-clocks.cpp.

---

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

• os-clocks.h
• os-clocks.cpp