uvco::Ticker Class Reference

#include <timer.h>

Inheritance diagram for uvco::Ticker:

Public Member Functions
	Ticker ()=default
virtual	~Ticker ()=default
virtual MultiPromise< uint64_t >	ticker ()=0
virtual 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 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:

• uvco/timer.h