Event Class Reference

Abstraction of a event. An event object is a synchronization object whose state can be explicitly set to signaled by use of the Set function. The threads waiting for the event will be resumed. More...

Detailed Description

Abstraction of a event. An event object is a synchronization object whose state can be explicitly set to signaled by use of the Set function. The threads waiting for the event will be resumed.

Inheritance diagram for Event:

Public Member Methods
	Event (bool manualReset=true, bool initialState=false)
	Constructor. More...
	Event (PCChar8 name, bool manualReset=true, bool initialState=false)
	Constructor. More...
virtual	~Event ()
	Destructor. More...
virtual bool	Wait (TimeSpan timeOut=TimeInfinite)
	Waits. More...
virtual void	Set ()
	Sets the event. More...
virtual void	Reset ()
	Resets the event. More...
virtual void	Pulse ()
	Pulses the event. More...

Constructor & Destructor Documentation

Event	(	bool	manualReset = true,
		bool	initialState = false
	)

Constructor.

Parameters

manualReset	(optional) Manual reset enable. Default = true
initialState	(optional) Initial event state. Default = false

Warning

Non-Deterministic. Determinism when using ConceptRT library can be ensure by using Context Time Critical mechanisms.

Event	(	PCChar8	name,
		bool	manualReset = true,
		bool	initialState = false
	)

Constructor.

Parameters

name	The name.
manualReset	(optional) Manual reset enable. Default = true.
initialState	(optional) Initial event state. Default = false.

Warning

Non-Deterministic. Determinism when using ConceptRT library can be ensure by using Context Time Critical mechanisms.

virtual ~Event ( )

virtual

Destructor.

Warning

Non-Deterministic. Determinism when using ConceptRT library can be ensure by using Context Time Critical mechanisms.

Methods Documentation

virtual void Pulse ( )

virtual

Pulses the event.

virtual void Reset ( )

virtual

Resets the event.

virtual void Set ( )

virtual

Sets the event.

virtual bool Wait ( TimeSpan  timeOut = TimeInfinite )

virtual

Waits.

Parameters

timeOut

(optional) the time out.

Returns

true if event raised, false if timeout occurs.