ADTF  v2.14.3
cEvent Class Reference

Event class. More...

Inheritance diagram for cEvent:

Public Member Functions

 cEvent ()
 Default constructor.
 
virtual ~cEvent ()
 Destructor.
 
tResult Set ()
 Sets the event, emits the signal. More...
 
tResult Wait (tInt nTimeout=WAIT_Infinite)
 Wait for the event to be set. More...
 

Friends

class cManualEvent
 

Additional Inherited Members

- Static Public Attributes inherited from IWaitableObject
static const tInt WAIT_Infinite = -1
 value for infinite wait time
 

Detailed Description

Event class.

The event will be reset each time a Wait returns successfully.

Definition at line 139 of file thread.h.

Member Function Documentation

tResult Set ( )

Sets the event, emits the signal.

Return values
ERR_NO_ERRORif all went well.
ERR_NOT_INITIALISEDif mutex was not initialized
ERR_FAILEDif event could not be set
This method is real-time safe.
See The ADTF Real-Time Extension.
tResult Wait ( tInt  nTimeout = WAIT_Infinite)
virtual

Wait for the event to be set.

Parameters
nTimeout[in] Maximum time to wait in ms.
Return values
ERR_NOT_INITIALISEDevent was not initialized
ERR_TIMEOUTin case of timeout.
ERR_FAILEDan unknown error occured
ERR_INVALID_ARGin case event was abandoned by owning thread [Windows only !!!]
ERR_NOERRORcondition received
This method is real-time safe.
See The ADTF Real-Time Extension.

Implements IWaitableObject.


Copyright © Audi Electronics Venture GmbH. All rights reserved. (Generated on Fri Mar 22 2019 by doxygen 1.8.10)