tsm::timeout_ticks_awaitable Struct Reference

#include <coroutine.h>

Collaboration diagram for tsm::timeout_ticks_awaitable:

Public Member Functions
bool	await_ready () const noexcept
void	await_suspend (task::handle_type handle) const noexcept
void	await_cancel (task_context &context) const noexcept
void	await_resume () const noexcept

Public Attributes
tsm::tick_rep	ticks {}

Detailed Description

Awaitable returned by timeout_ticks.

This is a semantic timer source for select: it becomes ready when the task is woken by the scheduler timer queue. It does not read a platform clock. A task can race an event wait against a bounded explicit-tick timeout while keeping cancellation local to the losing awaitable branch.

Member Function Documentation

await_cancel()

void tsm::timeout_ticks_awaitable::await_cancel ( task_context &  context ) const

inlinenoexcept

await_ready()

bool tsm::timeout_ticks_awaitable::await_ready ( ) const

inlinenoexcept

await_resume()

void tsm::timeout_ticks_awaitable::await_resume ( ) const

inlinenoexcept

await_suspend()

void tsm::timeout_ticks_awaitable::await_suspend ( task::handle_type  handle ) const

inlinenoexcept

Member Data Documentation

ticks

tsm::tick_rep tsm::timeout_ticks_awaitable::ticks {}

---

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

• include/tsm/runtime/coroutine.h