Thread

Documentation

Overview

Package Thread provides methods for working with Thread object instances.

Index

• func SetThreadSafetyChecksEnabled(enabled bool)
• type Advanced
• type Any
• type Instance
  • func New() Instance
  • func (self Instance) AsObject() [1]gd.Object
  • func (self Instance) AsRefCounted() [1]gd.RefCounted
  • func (self Instance) AsThread() Instance
  • func (self Instance) GetId() string
  • func (self Instance) IsAlive() bool
  • func (self Instance) IsStarted() bool
  • func (self Instance) Start(callable func()) error
  • func (self *Instance) UnsafePointer() unsafe.Pointer
  • func (self Instance) Virtual(name string) reflect.Value
  • func (self Instance) WaitToFinish() any
• type Priority

Functions

func SetThreadSafetyChecksEnabled

func SetThreadSafetyChecksEnabled(enabled bool)

Sets whether the thread safety checks the engine normally performs in methods of certain classes (e.g., [Node]) should happen [b]on the current thread[/b]. The default, for every thread, is that they are enabled (as if called with [param enabled] being [code]true[/code]). Those checks are conservative. That means that they will only succeed in considering a call thread-safe (and therefore allow it to happen) if the engine can guarantee such safety. Because of that, there may be cases where the user may want to disable them ([param enabled] being [code]false[/code]) to make certain operations allowed again. By doing so, it becomes the user's responsibility to ensure thread safety (e.g., by using [Mutex]) for those objects that are otherwise protected by the engine. [b]Note:[/b] This is an advanced usage of the engine. You are advised to use it only if you know what you are doing and there is no safer way. [b]Note:[/b] This is useful for scripts running on either arbitrary [Thread] objects or tasks submitted to the [WorkerThreadPool]. It doesn't apply to code running during [Node] group processing, where the checks will be always performed. [b]Note:[/b] Even in the case of having disabled the checks in a [WorkerThreadPool] task, there's no need to re-enable them at the end. The engine will do so.

Types

type Advanced

type Advanced = class

Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.

type Any

type Any interface {
	gd.IsClass
	AsThread() Instance
}

type Instance

type Instance [1]gdclass.Thread

A unit of execution in a process. Can run methods on [Object]s simultaneously. The use of synchronization via [Mutex] or [Semaphore] is advised if working with shared objects. [b]Warning:[/b] To ensure proper cleanup without crashes or deadlocks, when a [Thread]'s reference count reaches zero and it is therefore destroyed, the following conditions must be met: - It must not have any [Mutex] objects locked. - It must not be waiting on any [Semaphore] objects. - [method wait_to_finish] should have been called on it.

var Nil Instance

Nil is a nil/null instance of the class. Equivalent to the zero value.

func New

func New() Instance

func (Instance) AsObject

func (self Instance) AsObject() [1]gd.Object

func (Instance) AsRefCounted

func (self Instance) AsRefCounted() [1]gd.RefCounted

func (Instance) AsThread

func (self Instance) AsThread() Instance

func (Instance) GetId

func (self Instance) GetId() string

Returns the current [Thread]'s ID, uniquely identifying it among all threads. If the [Thread] has not started running or if [method wait_to_finish] has been called, this returns an empty string.

func (Instance) IsAlive

func (self Instance) IsAlive() bool

Returns [code]true[/code] if this [Thread] is currently running the provided function. This is useful for determining if [method wait_to_finish] can be called without blocking the calling thread. To check if a [Thread] is joinable, use [method is_started].

func (Instance) IsStarted

func (self Instance) IsStarted() bool

Returns [code]true[/code] if this [Thread] has been started. Once started, this will return [code]true[/code] until it is joined using [method wait_to_finish]. For checking if a [Thread] is still executing its task, use [method is_alive].

func (Instance) Start

func (self Instance) Start(callable func()) error

Starts a new [Thread] that calls [param callable]. If the method takes some arguments, you can pass them using [method Callable.bind]. The [param priority] of the [Thread] can be changed by passing a value from the [enum Priority] enum. Returns [constant OK] on success, or [constant ERR_CANT_CREATE] on failure.

func (*Instance) UnsafePointer

func (self *Instance) UnsafePointer() unsafe.Pointer

func (Instance) Virtual

func (self Instance) Virtual(name string) reflect.Value

func (Instance) WaitToFinish

func (self Instance) WaitToFinish() any

Joins the [Thread] and waits for it to finish. Returns the output of the [Callable] passed to [method start]. Should either be used when you want to retrieve the value returned from the method called by the [Thread] or before freeing the instance that contains the [Thread]. To determine if this can be called without blocking the calling thread, check if [method is_alive] is [code]false[/code].

type Priority

type Priority = gdclass.ThreadPriority //gd:Thread.Priority

const (
	/*A thread running with lower priority than normally.*/
	PriorityLow Priority = 0
	/*A thread with a standard priority.*/
	PriorityNormal Priority = 1
	/*A thread running with higher priority than normally.*/
	PriorityHigh Priority = 2
)