uvco 0.1
Loading...
Searching...
No Matches
Public Member Functions | List of all members
uvco::Ticker Class Referenceabstract

#include <timer.h>

Inheritance diagram for uvco::Ticker:
Inheritance graph
[legend]

Public Member Functions

 Ticker ()=default
 
virtual ~Ticker ()=default
 
virtual MultiPromise< uint64_t > ticker ()=0
 
virtual Promise< void > close ()=0
 Immediately stop the ticker.
 

Detailed Description

A ticker produces events with a given periodicity. Use tick() to create a Ticker instance.

Constructor & Destructor Documentation

◆ Ticker()

uvco::Ticker::Ticker ( )
default

◆ ~Ticker()

virtual uvco::Ticker::~Ticker ( )
virtualdefault

Member Function Documentation

◆ close()

virtual Promise< void > uvco::Ticker::close ( )
pure virtual

Immediately stop the ticker.

Implemented in uvco::TickerImpl.

◆ ticker()

virtual MultiPromise< uint64_t > uvco::Ticker::ticker ( )
pure virtual

A promise generating successive integers. If a count was given upon creation, the last tick after reaching 0 will yield std::nullopt.

Implemented in uvco::TickerImpl.


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