uvco::TickerImpl Class Reference

Non-movable, non-copyable: because the awaiter is called by a callback. More...

Inheritance diagram for uvco::TickerImpl:

Collaboration diagram for uvco::TickerImpl:

Public Member Functions
	TickerImpl (const TickerImpl &)=delete
	TickerImpl (TickerImpl &&)=default
TickerImpl &	operator= (const TickerImpl &)=delete
TickerImpl &	operator= (TickerImpl &&)=default
	TickerImpl (std::unique_ptr< TimerAwaiter > awaiter, uint64_t max)
	~TickerImpl () override=default
MultiPromise< uint64_t >	ticker () override
void	close () override
	Immediately stop the ticker.
Public Member Functions inherited from uvco::Ticker
	Ticker ()=default
virtual	~Ticker ()=default

Private Attributes
std::unique_ptr< TimerAwaiter >	awaiter_
uint64_t	count_max_
bool	stopped_ = false
bool	running_ = false

Detailed Description

Non-movable, non-copyable: because the awaiter is called by a callback.

Constructor & Destructor Documentation

TickerImpl() [1/3]

uvco::TickerImpl::TickerImpl ( const TickerImpl & )

delete

TickerImpl() [2/3]

uvco::TickerImpl::TickerImpl ( TickerImpl && )

default

TickerImpl() [3/3]

uvco::TickerImpl::TickerImpl ( std::unique_ptr< TimerAwaiter > awaiter, uint64_t max )

inline

      : awaiter_{std::move(awaiter)}, count_max_{max} {}

~TickerImpl()

uvco::TickerImpl::~TickerImpl ( )

overridedefault

Member Function Documentation

close()

void uvco::TickerImpl::close ( )

overridevirtual

Immediately stop the ticker.

Implements uvco::Ticker.

                       {
  stopped_ = true;
  // The stopped awaiter will yield a false event, and then break out of the
  // loop (ticker() method).
  awaiter_->resume();
  awaiter_->stop();
  awaiter_->close();
}

operator=() [1/2]

TickerImpl & uvco::TickerImpl::operator= ( const TickerImpl & )

delete

operator=() [2/2]

TickerImpl & uvco::TickerImpl::operator= ( TickerImpl && )

default

ticker()

MultiPromise< uint64_t > uvco::TickerImpl::ticker ( )

overridevirtual

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

Implements uvco::Ticker.

                                          {
  FlagGuard guard(running_);
 
  uint64_t counter = 0;
  while (!stopped_ && (count_max_ == 0 || counter < count_max_)) {
    // Resumed from onMultiTimerFired():
    if (co_await *awaiter_) {
      if (stopped_) {
        break;
      }
      co_yield counter;
      ++counter;
    }
  }
  // Clean up if not stopped manually from stop().
  if (!stopped_) {
    // Need to close timer so that libuv isn't blocked by the active handle on
    // the loop.
    close();
  }
}

Member Data Documentation

awaiter_

std::unique_ptr<TimerAwaiter> uvco::TickerImpl::awaiter_

private

count_max_

uint64_t uvco::TickerImpl::count_max_

private

running_

bool uvco::TickerImpl::running_ = false

private

stopped_

bool uvco::TickerImpl::stopped_ = false

private

---

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

• uvco/timer.cc