Event

Overview

System event, can be used to wake up things that are (blocking) waiting for something to happen.

Location

  • Reference:
    • Elements.dll  .NET, .NET Core 6.0, .NET Standard 2.0
    • elements.jar  Cooper
    • Elements.fx  Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator, Island-Windows, ToffeeV2
    • libElements.fx  Toffee
  • Namespace: RemObjects.Elements.RTL
  • Platforms: .NET, .NET Core 6.0, .NET Standard 2.0, Cooper, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator, Island-Windows, Toffee, ToffeeV2

Instance Methods

constructor

 

constructor withState(aState: Boolean := false) Mode(aMode: EventMode := EventMode.AutoReset)

 

Event withState(Boolean aState = false) Mode(EventMode aMode = EventMode.AutoReset)

 

init(state aState: Boolean = false, Mode aMode: EventMode = EventMode.AutoReset)

 

Event withState(Boolean aState) Mode(EventMode aMode)

 

Sub New withState(aState As Boolean = false) Mode(aMode As EventMode = EventMode.AutoReset)

Parameters:

  • aState:
  • aMode:

Dispose

Dispose this instance

 

method Dispose

 

void Dispose()

 

func Dispose()

 

void Dispose()

 

Sub Dispose()

Reset

Clears the event, wait for will block.

 

method Reset

 

void Reset()

 

func Reset()

 

void Reset()

 

Sub Reset()

Set

Sets the event; depending on the mode this sets it just once, or automatically resets it after the first thread waits for it.

 

method Set

 

void Set()

 

func Set()

 

void Set()

 

Sub Set()

WaitFor

Wait for the event to be set.

 

method WaitFor

 

void WaitFor()

 

func WaitFor()

 

void WaitFor()

 

Sub WaitFor()

WaitFor (TimeSpan): Boolean

Wait for with a given timeout. Returns true on success.

 

method WaitFor(aTimeout: TimeSpan): Boolean

 

Boolean WaitFor(TimeSpan aTimeout)

 

func WaitFor(_ aTimeout: TimeSpan) -> Boolean

 

Boolean WaitFor(TimeSpan aTimeout)

 

Function WaitFor(aTimeout As TimeSpan) As Boolean

Parameters:

  • aTimeout:

WaitFor (Int32): Boolean

Wait for with a given timeout. Returns true on success.

 

method WaitFor(aTimeoutInMilliseconds: Int32): Boolean

 

Boolean WaitFor(Int32 aTimeoutInMilliseconds)

 

func WaitFor(_ aTimeoutInMilliseconds: Int32) -> Boolean

 

Boolean WaitFor(Integer aTimeoutInMilliseconds)

 

Function WaitFor(aTimeoutInMilliseconds As Int32) As Boolean

Parameters:

  • aTimeoutInMilliseconds: