Mutex

Overview

Mutex locking object.

Location

Reference: Island.fx
Namespace: RemObjects.Elements.System
Platforms: Android, Fuchsia, iOS, iOS Simulator, Mac Catalyst, macOS, tvOS, tvOS Simulator, Ubuntu, visionOS, visionOS Simulator, watchOS, watchOS Simulator, Windows
Ancestry: WaitHandle | Mutex

constructor protected (declared in WaitHandle) Android, Fuchsia, iOS, iOS Simulator, Mac Catalyst, macOS, tvOS, tvOS Simulator, Ubuntu, visionOS, visionOS Simulator, watchOS, watchOS Simulator

constructor

Mutex()

init()

Mutex()

Sub New()

constructor (HANDLE) (declared in WaitHandle) Windows

constructor(aHandle: HANDLE)

Mutex(HANDLE aHandle)

init(_ aHandle: HANDLE)

Mutex(HANDLE aHandle)

Sub New(aHandle As HANDLE)

Parameters:

aHandle:

constructor (Boolean)

constructor(aInitialValue: Boolean)

Mutex(Boolean aInitialValue)

init(_ aInitialValue: Boolean)

Mutex(Boolean aInitialValue)

Sub New(aInitialValue As Boolean)

Parameters:

aInitialValue:

Dispose (declared in WaitHandle)

method Dispose

void Dispose()

func Dispose()

void Dispose()

Sub Dispose()

DoDispose protected override virtual Android, Fuchsia, iOS, iOS Simulator, Mac Catalyst, macOS, tvOS, tvOS Simulator, Ubuntu, visionOS, visionOS Simulator, watchOS, watchOS Simulator

method DoDispose

void DoDispose()

func DoDispose()

void DoDispose()

Sub DoDispose()

DoWait protected override virtual Android, Fuchsia, iOS, iOS Simulator, Mac Catalyst, macOS, tvOS, tvOS Simulator, Ubuntu, visionOS, visionOS Simulator, watchOS, watchOS Simulator

method DoWait

void DoWait()

func DoWait()

void DoWait()

Sub DoWait()

DoWait (Int32): Boolean protected virtual abstract (declared in WaitHandle) Android, Fuchsia, iOS, iOS Simulator, Mac Catalyst, macOS, tvOS, tvOS Simulator, Ubuntu, visionOS, visionOS Simulator, watchOS, watchOS Simulator

method DoWait(aTimeMS: Int32): Boolean

Boolean DoWait(Int32 aTimeMS)

func DoWait(_ aTimeMS: Int32) -> Boolean

Boolean DoWait(Int32 aTimeMS)

Function DoWait(aTimeMS As Int32) As Boolean

Parameters:

aTimeMS:

Equals virtual (declared in Object)

Default constructor.

method Equals(aOther: Object): Boolean

Boolean Equals(Object aOther)

func Equals(_ aOther: Object) -> Boolean

Boolean Equals(Object aOther)

Function Equals(aOther As Object) As Boolean

Parameters:

aOther: the reference to compare this with.

Finalize protected virtual (declared in Object)

method Finalize

void Finalize()

func Finalize()

void Finalize()

Sub Finalize()

GetHashCode virtual (declared in Object)

Returns a hashcode for this object. Overriden implementations should make sure that the number returned here is constant given the same object.

method GetHashCode: Int32

Int32 GetHashCode()

func GetHashCode() -> Int32

Int32 GetHashCode()

Function GetHashCode() As Int32

GetType (declared in Object)

Returns the actual type of this class

method GetType: Type

Type GetType()

func GetType() -> Type

Type GetType()

Function GetType() As Type

ReferenceEquals (declared in Object)

Compares two references for equivalence (even if they have an equals operator)

class method ReferenceEquals(a: Object; b: Object): Boolean

static Boolean ReferenceEquals(Object a, Object b)

static func ReferenceEquals(_ a: Object, _ b: Object) -> Boolean

static Boolean ReferenceEquals(Object a, Object b)

Shared Function ReferenceEquals(a As Object, b As Object) As Boolean

Parameters:

a: left value
b: right value

Release

method Release

void Release()

func Release()

void Release()

Sub Release()

ToString virtual (declared in Object)

Gets the string representation of this method.

method ToString: String

String ToString()

func ToString() -> String

String ToString()

Function ToString() As String

Wait (declared in WaitHandle)

method Wait

void Wait()

func Wait()

void Wait()

Sub Wait()

Wait (Int32): Boolean (declared in WaitHandle)

Wait for this event/mutex to trigger; a timeout of aTimeoutMS msec. Returns true if successful, false for a timeout.

method Wait(aTimeMS: Int32): Boolean

Boolean Wait(Int32 aTimeMS)

func Wait(_ aTimeMS: Int32) -> Boolean

Boolean Wait(Int32 aTimeMS)

Function Wait(aTimeMS As Int32) As Boolean

Parameters:

aTimeMS: The nr of msec to wait

ReferenceEquals (declared in Object)

Compares two references for equivalence (even if they have an equals operator)

class method ReferenceEquals(a: Object; b: Object): Boolean

static Boolean ReferenceEquals(Object a, Object b)

static func ReferenceEquals(_ a: Object, _ b: Object) -> Boolean

static Boolean ReferenceEquals(Object a, Object b)

Shared Function ReferenceEquals(a As Object, b As Object) As Boolean

Parameters:

a: left value
b: right value

constructor

Mutex()

init()

Mutex()

Sub New()

constructor (HANDLE) (declared in WaitHandle) Windows

constructor(aHandle: HANDLE)

Mutex(HANDLE aHandle)

init(_ aHandle: HANDLE)

Mutex(HANDLE aHandle)

Sub New(aHandle As HANDLE)

Parameters:

aHandle:

constructor (Boolean)

constructor(aInitialValue: Boolean)

Mutex(Boolean aInitialValue)

init(_ aInitialValue: Boolean)

Mutex(Boolean aInitialValue)

Sub New(aInitialValue As Boolean)

Parameters:

aInitialValue:

Dispose (declared in WaitHandle)

method Dispose

void Dispose()

func Dispose()

void Dispose()

Sub Dispose()

DoDispose protected override virtual Android, Fuchsia, iOS, iOS Simulator, Mac Catalyst, macOS, tvOS, tvOS Simulator, Ubuntu, visionOS, visionOS Simulator, watchOS, watchOS Simulator

method DoDispose

void DoDispose()

func DoDispose()

void DoDispose()

Sub DoDispose()

DoWait protected override virtual Android, Fuchsia, iOS, iOS Simulator, Mac Catalyst, macOS, tvOS, tvOS Simulator, Ubuntu, visionOS, visionOS Simulator, watchOS, watchOS Simulator

method DoWait

void DoWait()

func DoWait()

void DoWait()

Sub DoWait()

method DoWait(aTimeMS: Int32): Boolean

Boolean DoWait(Int32 aTimeMS)

func DoWait(_ aTimeMS: Int32) -> Boolean

Boolean DoWait(Int32 aTimeMS)

Function DoWait(aTimeMS As Int32) As Boolean

Parameters:

aTimeMS:

Equals virtual (declared in Object)

Default constructor.

method Equals(aOther: Object): Boolean

Boolean Equals(Object aOther)

func Equals(_ aOther: Object) -> Boolean

Boolean Equals(Object aOther)

Function Equals(aOther As Object) As Boolean

Parameters:

aOther: the reference to compare this with.

Finalize protected virtual (declared in Object)

method Finalize

void Finalize()

func Finalize()

void Finalize()

Sub Finalize()

GetHashCode virtual (declared in Object)

Returns a hashcode for this object. Overriden implementations should make sure that the number returned here is constant given the same object.

method GetHashCode: Int32

Int32 GetHashCode()

func GetHashCode() -> Int32

Int32 GetHashCode()

Function GetHashCode() As Int32

GetType (declared in Object)

Returns the actual type of this class

method GetType: Type

Type GetType()

func GetType() -> Type

Type GetType()

Function GetType() As Type

Release

method Release

void Release()

func Release()

void Release()

Sub Release()

ToString virtual (declared in Object)

Gets the string representation of this method.

method ToString: String

String ToString()

func ToString() -> String

String ToString()

Function ToString() As String

Wait (declared in WaitHandle)

method Wait

void Wait()

func Wait()

void Wait()

Sub Wait()

Wait (Int32): Boolean (declared in WaitHandle)

Wait for this event/mutex to trigger; a timeout of aTimeoutMS msec. Returns true if successful, false for a timeout.

method Wait(aTimeMS: Int32): Boolean

Boolean Wait(Int32 aTimeMS)

func Wait(_ aTimeMS: Int32) -> Boolean

Boolean Wait(Int32 aTimeMS)

Function Wait(aTimeMS As Int32) As Boolean

Parameters:

aTimeMS: The nr of msec to wait