Semaphore

package
v0.0.0-...-a66c66c Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 12, 2025 License: MIT Imports: 22 Imported by: 0

Documentation

Overview

Package Semaphore provides methods for working with Semaphore object instances.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

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
	AsSemaphore() Instance
}

type Expanded

type Expanded [1]gdclass.Semaphore

func (Expanded) Post

func (self Expanded) Post(count int)

Lowers the [Semaphore], allowing one thread in, or more if [param count] is specified.

type Extension

type Extension[T gdclass.Interface] struct{ gdclass.Extension[T, Instance] }

Extension can be embedded in a new struct to create an extension of this class. T should be the type that is embedding this Extension

func (*Extension[T]) AsObject

func (self *Extension[T]) AsObject() [1]gd.Object

func (*Extension[T]) AsRefCounted

func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted

func (*Extension[T]) AsSemaphore

func (self *Extension[T]) AsSemaphore() Instance

type ID

type ID Object.ID

ID is a typed object ID (reference) to an instance of this class, use it to store references to objects with unknown lifetimes, as an ID will not panic on use if the underlying object has been destroyed.

func (ID) Instance

func (id ID) Instance() (Instance, bool)

type Instance

type Instance [1]gdclass.Semaphore

A synchronization semaphore that can be used to synchronize multiple [Thread]s. Initialized to zero on creation. For a binary version, see [Mutex]. [b]Warning:[/b] Semaphores must be used carefully to avoid deadlocks. [b]Warning:[/b] To guarantee that the operating system is able to perform proper cleanup (no crashes, no deadlocks), these conditions must be met: - When a [Semaphore]'s reference count reaches zero and it is therefore destroyed, no threads must be waiting on it. - When a [Thread]'s reference count reaches zero and it is therefore destroyed, it must not be waiting on any semaphore.

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

func (self Instance) AsSemaphore() Instance

func (Instance) ID

func (self Instance) ID() ID

func (Instance) Post

func (self Instance) Post()

Lowers the [Semaphore], allowing one thread in, or more if [param count] is specified.

func (*Instance) SetObject

func (self *Instance) SetObject(obj [1]gd.Object) bool

func (Instance) TryWait

func (self Instance) TryWait() bool

Like [method wait], but won't block, so if the value is zero, fails immediately and returns [code]false[/code]. If non-zero, it returns [code]true[/code] to report success.

func (Instance) Virtual

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

func (Instance) Wait

func (self Instance) Wait()

Waits for the [Semaphore], if its value is zero, blocks until non-zero.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL