CTR Pia  4.11.3
Game Communication Engine
nn::pia::common::Event Class Reference

This class represents events. More...

Public Member Functions

 Event ()
 Instantiates the object. More...
 
 ~Event ()
 Destroys the object.
 
void Finalize ()
 Destroys an event. More...
 
nn::os::LightEvent * GetRawLightEvent ()
 Gets this nn::os::LightEvent instance. More...
 
void Initialize (bool bManualReset=true)
 Initializes an event. More...
 
void Reset ()
 Puts the event in the non-signal state. More...
 
void Signal ()
 Puts the event in the signal state. More...
 
bool TryWait ()
 Determines whether the event is in the signal state. More...
 
void Wait ()
 Waits for the event to enter the signal state. More...
 

Detailed Description

This class represents events.


Revision History:

2012-10-30 Added TryWait.

2012-09-21 Made functions public.

Constructor & Destructor Documentation

nn::pia::common::Event::Event ( )

Instantiates the object.

You must explicitly call Initialize to use an event.

Member Function Documentation

void nn::pia::common::Event::Finalize ( )

Destroys an event.

See also
Initialize
nn::os::LightEvent* nn::pia::common::Event::GetRawLightEvent ( )
inline

Gets this nn::os::LightEvent instance.

Returns
Returns this nn::os::LightEvent instance.
void nn::pia::common::Event::Initialize ( bool  bManualReset = true)

Initializes an event.

Parameters
[in]bManualResetSpecify true for manual reset, or false for automatic reset.
See also
Finalize
void nn::pia::common::Event::Reset ( )

Puts the event in the non-signal state.

See also
Signal
void nn::pia::common::Event::Signal ( )

Puts the event in the signal state.

See also
Wait, Reset
bool nn::pia::common::Event::TryWait ( )

Determines whether the event is in the signal state.

Clears the signal state if the event is an automatic reset event.

See also
Wait
void nn::pia::common::Event::Wait ( )

Waits for the event to enter the signal state.

See also
Signal