Marco Zecchini / Mbed OS Example_RTOS

Rtos API example

Embed: (wiki syntax)

« Back to documentation index

Event< void()> Class Template Reference
Public Member Functions | Static Public Member Functions

Event< void()> Class Template Reference
[Events]

Event. More...

#include <Event.h>

Public Member Functions

template<typename F >
 Event (EventQueue *q, F f)
 Create an event.
 Event (const Event &e)
 Copy constructor for events.
Event & operator= (const Event &that)
 Assignment operator for events.
 ~Event ()
 Destructor for events.
void delay (int delay)
 Configure the delay of an event.
void period (int period)
 Configure the period of an event.
int post () const
 Posts an event onto the underlying event queue.
void call () const
 Posts an event onto the underlying event queue, returning void.
void operator() () const
 Posts an event onto the underlying event queue, returning void.
void cancel () const
 Cancels the most recently posted event.
template<typename F , typename C0 >
 Event (EventQueue *q, F f, C0 c0)
 Create an event.
template<typename F , typename C0 , typename C1 >
 Event (EventQueue *q, F f, C0 c0, C1 c1)
 Create an event.
template<typename F , typename C0 , typename C1 , typename C2 >
 Event (EventQueue *q, F f, C0 c0, C1 c1, C2 c2)
 Create an event.
template<typename F , typename C0 , typename C1 , typename C2 , typename C3 >
 Event (EventQueue *q, F f, C0 c0, C1 c1, C2 c2, C3 c3)
 Create an event.
template<typename F , typename C0 , typename C1 , typename C2 , typename C3 , typename C4 >
 Event (EventQueue *q, F f, C0 c0, C1 c1, C2 c2, C3 c3, C4 c4)
 Create an event.
template<typename T , typename R , typename B0 >
 Event (EventQueue *q, T *obj, R(T::*method)(B0), B0 b0)
 Create an event.
template<typename T , typename R , typename B0 >
 Event (EventQueue *q, const T *obj, R(T::*method)(B0) const, B0 b0)
 Create an event.
template<typename T , typename R , typename B0 >
 Event (EventQueue *q, volatile T *obj, R(T::*method)(B0) volatile, B0 b0)
 Create an event.
template<typename T , typename R , typename B0 >
 Event (EventQueue *q, const volatile T *obj, R(T::*method)(B0) const volatile, B0 b0)
 Create an event.
template<typename T , typename R , typename B0 , typename B1 >
 Event (EventQueue *q, T *obj, R(T::*method)(B0, B1), B0 b0, B1 b1)
 Create an event.
template<typename T , typename R , typename B0 , typename B1 >
 Event (EventQueue *q, const T *obj, R(T::*method)(B0, B1) const, B0 b0, B1 b1)
 Create an event.
template<typename T , typename R , typename B0 , typename B1 >
 Event (EventQueue *q, volatile T *obj, R(T::*method)(B0, B1) volatile, B0 b0, B1 b1)
 Create an event.
template<typename T , typename R , typename B0 , typename B1 >
 Event (EventQueue *q, const volatile T *obj, R(T::*method)(B0, B1) const volatile, B0 b0, B1 b1)
 Create an event.
template<typename T , typename R , typename B0 , typename B1 , typename B2 >
 Event (EventQueue *q, T *obj, R(T::*method)(B0, B1, B2), B0 b0, B1 b1, B2 b2)
 Create an event.
template<typename T , typename R , typename B0 , typename B1 , typename B2 >
 Event (EventQueue *q, const T *obj, R(T::*method)(B0, B1, B2) const, B0 b0, B1 b1, B2 b2)
 Create an event.
template<typename T , typename R , typename B0 , typename B1 , typename B2 >
 Event (EventQueue *q, volatile T *obj, R(T::*method)(B0, B1, B2) volatile, B0 b0, B1 b1, B2 b2)
 Create an event.
template<typename T , typename R , typename B0 , typename B1 , typename B2 >
 Event (EventQueue *q, const volatile T *obj, R(T::*method)(B0, B1, B2) const volatile, B0 b0, B1 b1, B2 b2)
 Create an event.
template<typename T , typename R , typename B0 , typename B1 , typename B2 , typename B3 >
 Event (EventQueue *q, T *obj, R(T::*method)(B0, B1, B2, B3), B0 b0, B1 b1, B2 b2, B3 b3)
 Create an event.
template<typename T , typename R , typename B0 , typename B1 , typename B2 , typename B3 >
 Event (EventQueue *q, const T *obj, R(T::*method)(B0, B1, B2, B3) const, B0 b0, B1 b1, B2 b2, B3 b3)
 Create an event.
template<typename T , typename R , typename B0 , typename B1 , typename B2 , typename B3 >
 Event (EventQueue *q, volatile T *obj, R(T::*method)(B0, B1, B2, B3) volatile, B0 b0, B1 b1, B2 b2, B3 b3)
 Create an event.
template<typename T , typename R , typename B0 , typename B1 , typename B2 , typename B3 >
 Event (EventQueue *q, const volatile T *obj, R(T::*method)(B0, B1, B2, B3) const volatile, B0 b0, B1 b1, B2 b2, B3 b3)
 Create an event.
template<typename T , typename R , typename B0 , typename B1 , typename B2 , typename B3 , typename B4 >
 Event (EventQueue *q, T *obj, R(T::*method)(B0, B1, B2, B3, B4), B0 b0, B1 b1, B2 b2, B3 b3, B4 b4)
 Create an event.
template<typename T , typename R , typename B0 , typename B1 , typename B2 , typename B3 , typename B4 >
 Event (EventQueue *q, const T *obj, R(T::*method)(B0, B1, B2, B3, B4) const, B0 b0, B1 b1, B2 b2, B3 b3, B4 b4)
 Create an event.
template<typename T , typename R , typename B0 , typename B1 , typename B2 , typename B3 , typename B4 >
 Event (EventQueue *q, volatile T *obj, R(T::*method)(B0, B1, B2, B3, B4) volatile, B0 b0, B1 b1, B2 b2, B3 b3, B4 b4)
 Create an event.
template<typename T , typename R , typename B0 , typename B1 , typename B2 , typename B3 , typename B4 >
 Event (EventQueue *q, const volatile T *obj, R(T::*method)(B0, B1, B2, B3, B4) const volatile, B0 b0, B1 b1, B2 b2, B3 b3, B4 b4)
 Create an event.

Static Public Member Functions

static void thunk (void *func)
 Static thunk for passing as C-style function.

Detailed Description

template<>
class events::Event< void()>

Event.

Representation of an event for fine-grain dispatch control

Definition at line 39 of file Event.h.

Constructor & Destructor Documentation

Event ( EventQueue *  q,
F  f 
)

Create an event.

Constructs an event bound to the specified event queue. The specified callback acts as the target for the event and is executed in the context of the event queue's dispatch loop once posted.

Parameters:
qEvent queue to dispatch on
fFunction to execute when the event is dispatched

Definition at line 51 of file Event.h.

Generated on Sun Jul 17 2022 08:25:43 by  doxygen 1.7.2