clan::Event Class Reference

OS level event. More...

#include <event.h>

Public Member Functions

Construction
 Event (bool manual_reset=true, bool initial_state=false)
 Constructs an event object. More...
 
 Event (EventProvider *event_provider)
 
 ~Event ()
 
Attributes
EventProviderget_event_provider () const
 Returns the event provider for this event. More...
 

Operations

bool wait (int timeout=-1)
 Wait for event to become flagged. More...
 
void set ()
 Flag event. More...
 
void reset ()
 Reset flag. More...
 
static int wait (int count, Event const *const *events, int timeout=-1)
 
static int wait (const std::vector< Event *> &events, int timeout=-1)
 
static int wait (const std::vector< Event > &events, int timeout=-1)
 
static int wait (Event &event1, int timeout=-1)
 
static int wait (Event &event1, Event &event2, int timeout=-1)
 
static int wait (Event &event1, Event &event2, Event &event3, int timeout=-1)
 
static int wait (Event &event1, Event &event2, Event &event3, Event &event4, int timeout=-1)
 
static int wait (Event &event1, Event &event2, Event &event3, Event &event4, Event &event5, int timeout=-1)
 
static int wait (Event &event1, Event &event2, Event &event3, Event &event4, Event &event5, Event &event6, int timeout=-1)
 
static int wait (Event &event1, Event &event2, Event &event3, Event &event4, Event &event5, Event &event6, Event &event7, int timeout=-1)
 
static int wait (Event &event1, Event &event2, Event &event3, Event &event4, Event &event5, Event &event6, Event &event7, Event &event8, int timeout=-1)
 

Detailed Description

OS level event.

Constructor & Destructor Documentation

◆ Event() [1/2]

clan::Event::Event ( bool  manual_reset = true,
bool  initial_state = false 
)

Constructs an event object.

◆ Event() [2/2]

clan::Event::Event ( EventProvider event_provider)

◆ ~Event()

clan::Event::~Event ( )

Member Function Documentation

◆ get_event_provider()

EventProvider* clan::Event::get_event_provider ( ) const

Returns the event provider for this event.

◆ reset()

void clan::Event::reset ( )

Reset flag.

◆ set()

void clan::Event::set ( )

Flag event.

◆ wait() [1/12]

bool clan::Event::wait ( int  timeout = -1)

Wait for event to become flagged.

Returns
true = When was flagged. Else timeout

◆ wait() [2/12]

static int clan::Event::wait ( int  count,
Event const *const *  events,
int  timeout = -1 
)
static

◆ wait() [3/12]

static int clan::Event::wait ( const std::vector< Event *> &  events,
int  timeout = -1 
)
static

◆ wait() [4/12]

static int clan::Event::wait ( const std::vector< Event > &  events,
int  timeout = -1 
)
static

◆ wait() [5/12]

static int clan::Event::wait ( Event event1,
int  timeout = -1 
)
static

◆ wait() [6/12]

static int clan::Event::wait ( Event event1,
Event event2,
int  timeout = -1 
)
static

◆ wait() [7/12]

static int clan::Event::wait ( Event event1,
Event event2,
Event event3,
int  timeout = -1 
)
static

◆ wait() [8/12]

static int clan::Event::wait ( Event event1,
Event event2,
Event event3,
Event event4,
int  timeout = -1 
)
static

◆ wait() [9/12]

static int clan::Event::wait ( Event event1,
Event event2,
Event event3,
Event event4,
Event event5,
int  timeout = -1 
)
static

◆ wait() [10/12]

static int clan::Event::wait ( Event event1,
Event event2,
Event event3,
Event event4,
Event event5,
Event event6,
int  timeout = -1 
)
static

◆ wait() [11/12]

static int clan::Event::wait ( Event event1,
Event event2,
Event event3,
Event event4,
Event event5,
Event event6,
Event event7,
int  timeout = -1 
)
static

◆ wait() [12/12]

static int clan::Event::wait ( Event event1,
Event event2,
Event event3,
Event event4,
Event event5,
Event event6,
Event event7,
Event event8,
int  timeout = -1 
)
static

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