Thread

Inherits: Reference < Object

Category: Core

Brief Description

A unit of execution in a process.

Member Functions

String	get_id ( ) const
bool	is_active ( ) const
Error	start ( Object instance, String method, Variant userdata=NULL, int priority=1 )
Variant	wait_to_finish ( )

Numeric Constants

• 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.

Member Function Description

String get_id ( ) const

Return the id of the thread, uniquely identifying it among all threads.

bool is_active ( ) const

Whether 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 )

Start a new Thread, it will run “method” on object “instance” using “userdata” as an argument and running with “priority”, one of 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.