COSA
An Object-Oriented Platform for Arduino Programming
Watchdog::Scheduler Class Reference

#include <Watchdog.hh>

Inheritance diagram for Watchdog::Scheduler:
Inheritance graph
Collaboration diagram for Watchdog::Scheduler:
Collaboration graph

Public Member Functions

 Scheduler ()
 
virtual uint32_t time ()
 
virtual bool start (Job *job)
 
virtual bool stop (Job *job)
 
virtual void dispatch ()
 

Protected Attributes

Head m_queue
 

Detailed Description

Watchdog Scheduler for jobs with milli-seconds as time unit. Constructor will automatically register the scheduler.

Definition at line 129 of file Watchdog.hh.

Constructor & Destructor Documentation

Watchdog::Scheduler::Scheduler ( )
inline

Construct and register a watchdog scheduler. Should be a singleton.

Definition at line 135 of file Watchdog.hh.

Member Function Documentation

void Job::Scheduler::dispatch ( )
virtualinherited

Dispatch expired jobs. This member function is typically called from an interrupt service routine.

Reimplemented in RTT::Scheduler.

Definition at line 53 of file Job_Scheduler.cpp.

bool Job::Scheduler::start ( Job job)
virtualinherited

Start given job. Returns true(1) if successful otherwise false(0).

Parameters
[in]jobto start.
Returns
bool.

Reimplemented in RTT::Scheduler.

Definition at line 24 of file Job_Scheduler.cpp.

bool Job::Scheduler::stop ( Job job)
virtualinherited

Stop given job. Returns true(1) if successful otherwise false(0).

Parameters
[in]jobto stop.
Returns
bool.

Definition at line 44 of file Job_Scheduler.cpp.

virtual uint32_t Watchdog::Scheduler::time ( )
inlinevirtual

Return current watchdog time in milli-seconds.

Returns
time in milli-seconds.
Note
atomic.

Implements Job::Scheduler.

Definition at line 146 of file Watchdog.hh.

Member Data Documentation

Head Job::Scheduler::m_queue
protectedinherited

Job queue.

Definition at line 84 of file Job.hh.


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