roo_scheduler
API Documentation for roo_scheduler
Loading...
Searching...
No Matches
Data Structures | Public Member Functions
roo_scheduler::IteratingTask Class Reference

#include <roo_scheduler.h>

Inheritance diagram for roo_scheduler::IteratingTask:
[legend]
Collaboration diagram for roo_scheduler::IteratingTask:
[legend]

Data Structures

class  Iterator
 

Public Member Functions

 IteratingTask (Scheduler &scheduler, Iterator &iterator, std::function< void()> done_cb=std::function< void()>())
 
bool start (roo_time::Uptime when=roo_time::Uptime::Now())
 
void execute (ExecutionID id) override
 
bool is_active () const
 
 ~IteratingTask ()
 
- Public Member Functions inherited from roo_scheduler::Executable
virtual ~Executable ()=default
 

Detailed Description

Definition at line 578 of file roo_scheduler.h.

Constructor & Destructor Documentation

◆ IteratingTask()

roo_scheduler::IteratingTask::IteratingTask ( Scheduler &  scheduler,
Iterator &  iterator,
std::function< void()>  done_cb = std::function<void()>() 
)

Definition at line 391 of file roo_scheduler.cpp.

◆ ~IteratingTask()

roo_scheduler::IteratingTask::~IteratingTask ( )

Definition at line 415 of file roo_scheduler.cpp.

References roo_scheduler::Scheduler::cancel().

Member Function Documentation

◆ execute()

void roo_scheduler::IteratingTask::execute ( ExecutionID  id)
overridevirtual

Implements roo_scheduler::Executable.

Definition at line 401 of file roo_scheduler.cpp.

References roo_scheduler::IteratingTask::Iterator::next(), and roo_scheduler::Scheduler::scheduleAfter().

◆ is_active()

bool roo_scheduler::IteratingTask::is_active ( ) const
inline

Definition at line 593 of file roo_scheduler.h.

Referenced by start().

◆ start()

bool roo_scheduler::IteratingTask::start ( roo_time::Uptime  when = roo_time::Uptime::Now())

Definition at line 395 of file roo_scheduler.cpp.

References is_active(), and roo_scheduler::Scheduler::scheduleOn().

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