Arduino-Scheduler
Portable Collaborative Multi-Tasking Scheduler for Arduino
Public Member Functions | Protected Attributes | List of all members
Event Class Reference
Collaboration diagram for Event:
Collaboration graph

Public Member Functions

 Event ()
 
unsigned int wait ()
 
void signal (unsigned int value)
 
void clear ()
 

Protected Attributes

volatile unsigned int m_event
 

Detailed Description

Definition at line 30 of file SchedulerEvent.ino.

Constructor & Destructor Documentation

Event::Event ( )
inline

Initiate task event.

Definition at line 35 of file SchedulerEvent.ino.

Member Function Documentation

void Event::clear ( )
inline

Clear event code to mark that it was completed.

Definition at line 63 of file SchedulerEvent.ino.

void Event::signal ( unsigned int  value)
inline

Signal task event. Wait for ongoing event handler, assign new event code and yield.

Parameters
[in]valueevent code (non zero).

Definition at line 53 of file SchedulerEvent.ino.

unsigned int Event::wait ( )
inline

Wait for task event. Returns event code (non zero). Typically called by event handler.

Returns
event.

Definition at line 42 of file SchedulerEvent.ino.

Member Data Documentation

volatile unsigned int Event::m_event
protected

Definition at line 69 of file SchedulerEvent.ino.

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