Thread

Inherits: Reference < Object

Category: Core

Brief Description

A unit of execution in a process.

Methods

Enumerations

enum Priority:

• PRIORITY_LOW = 0
• PRIORITY_NORMAL = 1
• PRIORITY_HIGH = 2

Description

A unit of execution in a process. Can run methods on Objects simultaneously. The use of synchronization via Mutex, Semaphore is advised if working with shared objects.

Method Descriptions

• String get_id ( ) const

Returns the current Threads id, uniquely identifying it among all threads.

• bool is_active ( ) const

Returns true if this Thread is currently active. An active Thread cannot start work on a new method but can be joined with wait_to_finish.

• Error start ( Object instance, String method, Variant userdata=null, int priority=1 )

Starts a new Thread that runs “method” on object “instance” with “userdata” passed as an argument. The “priority” of the Thread can be changed by passing a PRIORITY_* enum.

Returns OK on success, or ERR_CANT_CREATE on failure.

• Variant wait_to_finish ( )

Joins the Thread and waits for it to finish. Returns what the method called returned.