Job Class Reference

#include <Job.hh>

Inheritance diagram for Job:

Collaboration diagram for Job:

Classes
class	Scheduler

Public Member Functions
	Job (Scheduler *scheduler)
void	expire_at (uint32_t time)
void	expire_after (uint32_t time)
uint32_t	expire_at () const
int32_t	expire_after () const
uint32_t	time () const
bool	is_started () const
bool	start ()
bool	stop ()
virtual void	on_expired ()
virtual void	on_event (uint8_t type, uint16_t value)
virtual void	run ()
void	detach ()
Linkage *	succ () const
Linkage *	pred () const
void	attach (Linkage *pred)

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

Detailed Description

Abstract job class for handling of scheduled functions. The time scale depends on the queue handler (scheduler). There are three levels of queues predefined. The time resolutions are; seconds (Clock), milli-seconds (Watchdog) and micro-seconds (RTT).

Definition at line 33 of file Job.hh.

Constructor & Destructor Documentation

Job::Job ( Scheduler *  scheduler )

inline

Construct delayed job function. The virtual member function run() is called by the given scheduler when the scheduled time expires.

Parameters

[in]

scheduler

for the job.

Definition at line 92 of file Job.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 )

inline

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

inline

Get time remaining before expired.

Returns

time.

Definition at line 129 of file Job.hh.

void Job::expire_at ( uint32_t  time )

inline

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

inline

Get expire time.

Returns

time.

Definition at line 120 of file Job.hh.

bool Job::is_started ( ) const

inline

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

Returns

bool.

Definition at line 149 of file Job.hh.

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

inlinevirtual

Default job event handler; execute the run() virtual member function on timeout event. Event is pushed by on_expired().

Parameters

[in]	type	the type of event (Typically TIMEOUT_TYPE).
[in]	value	the event value.

Reimplemented from Event::Handler.

Reimplemented in ProtoThread, and Periodic.

Definition at line 197 of file Job.hh.

virtual void Job::on_expired ( )

inlinevirtual

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.

Linkage* Linkage::pred ( ) const

inlineinherited

Return predecessor in sequence.

Returns

predecessor linkage.

Definition at line 60 of file Linkage.hh.

virtual void Job::run ( )

inlinevirtual

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 ( )

inline

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

Returns

bool.

Definition at line 159 of file Job.hh.

bool Job::stop ( )

inline

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

inline

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

protected

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

Definition at line 214 of file Job.hh.

Linkage* Linkage::m_pred

protectedinherited

Definition at line 94 of file Linkage.hh.

Scheduler* Job::m_scheduler

protected

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/Job.hh