Bare Metal Programming Tool Kit
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Member Functions | Friends | List of all members
bmptk::rtos::event Class Reference

set of things that can happen, or a thing that has happened More...

#include <rtos.h>

Inheritance diagram for bmptk::rtos::event:
bmptk::rtos::waitable bmptk::rtos::flag

Public Member Functions

void print (std::ostream &s, bool header) const
 prints an event, for debugging only
 
bool operator== (const event &rhs) const
 report wether two events are the same
 
bool operator== (const waitable &rhs) const
 report whether an event corresponds to a waitable
 
bool operator!= (const event &rhs) const
 report wether two events are not the same
 
bool operator!= (const waitable &rhs) const
 report whether an event does not correspond to a waitable
 
event operator+ (const event &rhs) const
 add two waitables, result can be used in a wait() call
 

Friends

class waitable_set
 
class waitable
 
class channel_base
 
class flag
 
class callback
 
class clock
 
class timer
 
void beat ()
 

Detailed Description

set of things that can happen, or a thing that has happened

An event

The task::wait() calls return an event. Such an event can be compared to a waitable. The result is true if and only if the waitable caused the event.

Events are the only rtos objects that can be destroyed (without causing an error).

Definition at line 129 of file rtos.h.

Member Function Documentation

event bmptk::rtos::event::operator+ ( const event rhs) const

add two waitables, result can be used in a wait() call

Waitables can be added (operator+) to construct a 'set of waitables' as argument to a task::wait() call.


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