levent.h File Reference

Light event synchronization primitive [4.0.0+]. More...

#include "../types.h"
#include "../result.h"
#include "svc.h"

Go to the source code of this file.

Data Structures
struct	LEvent
	User-mode light event structure. More...

Functions
static void	leventInit (LEvent *le, bool signaled, bool autoclear)
	Initializes a user-mode light event. More...
bool	leventWait (LEvent *le, u64 timeout_ns)
	Waits on a user-mode light event. More...
bool	leventTryWait (LEvent *le)
	Polls a user-mode light event. More...
void	leventSignal (LEvent *le)
	Signals a user-mode light event. More...
void	leventClear (LEvent *le)
	Clears a user-mode light event. More...

Detailed Description

Light event synchronization primitive [4.0.0+].

Author

fincs

Copyright

libnx Authors

Function Documentation

leventClear()

void leventClear

(

LEvent *

le

)

Clears a user-mode light event.

Parameters

[in]

le

Pointer to LEvent structure.

leventInit()

static void leventInit ( LEvent *  le, bool  signaled, bool  autoclear  )

inlinestatic

Initializes a user-mode light event.

Parameters

[out]	le	Pointer to LEvent structure.
[in]	signaled	Whether the event starts off in signaled state.
[in]	autoclear	Autoclear flag.

leventSignal()

void leventSignal

(

LEvent *

le

)

Signals a user-mode light event.

Parameters

[in]

le

Pointer to LEvent structure.

leventTryWait()

bool leventTryWait

(

LEvent *

le

)

Polls a user-mode light event.

Parameters

[in]

le

Pointer to LEvent structure.

Returns

true if event is signaled, false otherwise.

leventWait()

bool leventWait	(	LEvent *	le,
		u64	timeout_ns
	)

Waits on a user-mode light event.

Parameters

[in]	le	Pointer to LEvent structure.
[in]	timeout_ns	Timeout in nanoseconds (pass UINT64_MAX to wait indefinitely).

Returns

true if wait succeeded, false if wait timed out.