Module event.event

Description

load event.event

This module provides the Event.Event class which provides a basic event implementation.

Packages

• Event

Classes

Event.Event

This class provides a basic event implementation that can only be setted or reseted.

This type is not copyable

Public members

Modifiers	Member	Description
const	clear	Resets the event.
const	delete	Cleans up the event instance.
const	getHandle	Returns the handle used by Event.Event.Event.Watcher.
const	isSet	Returns true if the event is set; otherwise returns false.
const	new	Creates a new event. The created event is not setted. If no event can be crea...
const	reset	Reset the internal event state
const	set	Sets the event.
const	wait	Waits until the event is set. If timeout is given, the wait stop after timeout...

Private members

Modifiers	Member	Description
const	clone	Disable object copy.
final	eventHandle	Internal handle.
@	g_lib	Global library handle.

Descriptions

Event.Event.clear

def (self)

Resets the event.

Event.Event.clone

none

Disable object copy.

Event.Event.delete

def (self)

Cleans up the event instance.

Event.Event.eventHandle

none

Internal handle.

Event.Event.g_lib

lib ('libmint-event')

Global library handle.

Event.Event.getHandle

def (const self)

Returns the handle used by Event.Watcher.

Event.Event.isSet

def (const self)

Returns true if the event is set; otherwise returns false.

Event.Event.new

def (self)

Creates a new event. The created event is not setted.

If no event can be created, none is returned.

Event.Event.reset

def (self)

Reset the internal event state

Event.Event.set

def (self)

Sets the event.

Event.Event.wait

def (self, timeout = none)

Waits until the event is set. If timeout is given, the wait stop after timeout milliseconds if the event is still not set.

Returns true if the event is set; otherwise returns false if the wait timed out.

After a call to this method, the event is reseted.