Periodic Class Reference

#include <Periodic.hh>

Inheritance diagram for Periodic:

Collaboration diagram for Periodic:

Public Member Functions
	Periodic (Job::Scheduler *scheduler, uint32_t period)
void	period (uint32_t time)
uint32_t	period () const
void	reschedule ()
void	expire_at (uint32_t time)
uint32_t	expire_at () const
void	expire_after (uint32_t time)
int32_t	expire_after () const
uint32_t	time () const
bool	is_started () const
bool	start ()
bool	stop ()
virtual void	on_expired ()
virtual void	run ()
void	detach ()
Linkage *	succ () const
Linkage *	pred () const
void	attach (Linkage *pred)

Protected Member Functions
virtual void	on_event (uint8_t type, uint16_t value)

Protected Attributes
uint32_t	m_period
uint32_t	m_expires
Scheduler *	m_scheduler
Linkage *	m_succ
Linkage *	m_pred

Detailed Description

Periodic function handler. Syntactic sugar for periodical jobs. Subclass and implement the virtual method run() as the function to be executed periodically. The scheduler defines the time base; the alarm scheduler uses seconds, the watchdog job scheduler milli-seconds and the real-time timer micro-seconds.

Also

For details on handling of time units see Job.hh. This execution pattern is also available in the FSM (Finite State Machine) class.

Definition at line 38 of file Periodic.hh.

Constructor & Destructor Documentation

Periodic::Periodic ( Job::Scheduler *  scheduler, uint32_t  period  )

inline

Construct a periodic function handled by the given scheduler and with the given period in the schedulers time base. The maximum period is UINT32_MAX; 1.2 hours with RTT::Scheduler, 49 days with Watchdog::Scheduler and 136 years with Alarm::Clock.

Parameters

[in]	scheduler	for the periodic job.
[in]	period	of timeout.

Definition at line 48 of file Periodic.hh.

Member Function Documentation

void Linkage::attach ( Linkage *  pred )

inlineinherited

Attach given linkage as predecessor. Will check and detach if already attached.

Parameters

[in]

pred

linkage to attach.

Note

atomic

Definition at line 71 of file Linkage.hh.

void Link::detach ( )

inlineinherited

Detach this link. Unlink from any list.

Definition at line 125 of file Linkage.hh.

void Job::expire_after ( uint32_t  time )

inlineinherited

Set expire time relative to latest expire time.

Parameters

[in]

time

to add to latest expire time.

Definition at line 111 of file Job.hh.

int32_t Job::expire_after ( ) const

inlineinherited

Get time remaining before expired.

Returns

time.

Definition at line 129 of file Job.hh.

void Job::expire_at ( uint32_t  time )

inlineinherited

Set expire time. Absolute time in scheduler time unit.

Parameters

[in]

time

to expire.

Definition at line 102 of file Job.hh.

uint32_t Job::expire_at ( ) const

inlineinherited

Get expire time.

Returns

time.

Definition at line 120 of file Job.hh.

bool Job::is_started ( ) const

inlineinherited

Return true(1) if the job is queued otherwise false(0).

Returns

bool.

Definition at line 149 of file Job.hh.

virtual void Periodic::on_event ( uint8_t  type, uint16_t  value  )

inlineprotectedvirtual

Periodic event handler; dispatch the run() function on timeout events and reschedule the periodic job.

Parameters

[in]	type	the type of event.
[in]	value	the event value.

Reimplemented from Job.

Definition at line 91 of file Periodic.hh.

virtual void Job::on_expired ( )

inlinevirtualinherited

Job member function that is called Scheduler::dispatch() when the job time has expired. This function is normally called from an interrupt service routine. The default implementation will push a timeout event with the job as target. The default event handler will call the job run() virtual member function. Override this function if the job should be executed during the interrupt service routine.

Definition at line 185 of file Job.hh.

void Periodic::period ( uint32_t  time )

inline

Set timeout period.

Parameters

[in]

time

period of timeout.

Definition at line 57 of file Periodic.hh.

uint32_t Periodic::period ( ) const

inline

Get timeout period.

Returns

period of timeout.

Definition at line 67 of file Periodic.hh.

Linkage* Linkage::pred ( ) const

inlineinherited

Return predecessor in sequence.

Returns

predecessor linkage.

Definition at line 60 of file Linkage.hh.

void Periodic::reschedule ( )

inline

Reschedule after a new period.

Definition at line 76 of file Periodic.hh.

virtual void Job::run ( )

inlinevirtualinherited

The job run() virtual member function; sub-class should define. Called by the scheduler (via event handler) when the time expires. May set an new expire time and start the job again, or even start other jobs.

Reimplemented in Button, Keypad, and Touch.

Definition at line 210 of file Job.hh.

bool Job::start ( )

inlineinherited

Start the job. Returns true(1) if scheduled otherwise false(0).

Returns

bool.

Definition at line 159 of file Job.hh.

bool Job::stop ( )

inlineinherited

Stop the job. Returns true(1) if scheduled otherwise false(0).

Returns

bool.

Definition at line 169 of file Job.hh.

Linkage* Linkage::succ ( ) const

inlineinherited

Return successor in sequence.

Returns

successor linkage.

Definition at line 51 of file Linkage.hh.

uint32_t Job::time ( ) const

inlineinherited

Get current scheduler time. May be used to set relative expire time.

Returns

time.

Definition at line 139 of file Job.hh.

Member Data Documentation

uint32_t Job::m_expires

protectedinherited

Expire time. Scale (us, ms, s) depends on scheduler.

Definition at line 214 of file Job.hh.

uint32_t Periodic::m_period

protected

Time period. Time unit is defined by the scheduler.

Definition at line 100 of file Periodic.hh.

Linkage* Linkage::m_pred

protectedinherited

Definition at line 94 of file Linkage.hh.

Scheduler* Job::m_scheduler

protectedinherited

Job scheduler.

Definition at line 217 of file Job.hh.

Linkage* Linkage::m_succ

protectedinherited

Double linked list pointers.

Definition at line 93 of file Linkage.hh.

---

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

• cores/cosa/Cosa/Periodic.hh