Module system.event

Description

load system.event

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

Packages

• System

Classes

System.Event

This class provides a basic event implementation that can only be set or reset.

This type is not copyable

Public members

Modifiers	Member	Description
const	clear	Resets the event.
const	getHandle	Returns the handle used by System.Event.System.Event.
const	getPollEvent	Returns the event's poll event as an instance of mint::poll_event_t.
const	isSet	Returns true if the event is set; otherwise returns false.
const	new	Creates a new event. The created event is not set. If no event can be created, ``...
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	d_ptr	Object data.
@ const	g_lib	Global library handle.

Descriptions

System.Event.clear

def (self)

Resets the event.

System.Event.clone

none

Disable object copy.

System.Event.d_ptr

null

Object data.

System.Event.g_lib

lib ('libmint-system')

Global library handle.

System.Event.getHandle

def (const self)

Returns the handle used by System.Event.

System.Event.getPollEvent

def (const self)

Returns the event's poll event as an instance of mint::poll_event_t.

System.Event.isSet

def (const self)

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

System.Event.new

def (self)

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

If no event can be created, none is returned.

System.Event.reset

def (self)

Reset the internal event state

System.Event.set

def (self)

Sets the event.

System.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 reset.