Thread

Overview

Class for multithreaded code

Location

  • Reference:
    • Elements.dll  .NET, .NET Standard 2.0
    • elements.jar  Cooper
    • Elements.fx  Island-Android, Island-iOS, Island-iOS Simulator-x86_64, Island-macOS-x86_64, Island-tvOS, Island-tvOS Simulator-x86_64, Island-Ubuntu, Island-UIKit for Mac-x86_64, Island-watchOS, Island-watchOS Simulator, Island-Windows, ToffeeV2
    • libElements.fx  Toffee
  • Namespace: RemObjects.Elements.RTL
  • Platforms: .NET, .NET Standard 2.0, Cooper, Island-Android, Island-iOS, Island-iOS Simulator-x86_64, Island-macOS-x86_64, Island-tvOS, Island-tvOS Simulator-x86_64, Island-Ubuntu, Island-UIKit for Mac-x86_64, Island-watchOS, Island-watchOS Simulator, Island-Windows, Toffee, ToffeeV2
  • Mapped to:
    • System.Threading.Thread  .NET, .NET Standard 2.0
    • java.lang.Thread  Cooper
    • RemObjects.Elements.System.Thread  Island-Android, Island-iOS, Island-iOS Simulator-x86_64, Island-macOS-x86_64, Island-tvOS, Island-tvOS Simulator-x86_64, Island-Ubuntu, Island-UIKit for Mac-x86_64, Island-watchOS, Island-watchOS Simulator, Island-Windows
    • Foundation.NSThread  Toffee, ToffeeV2

 

constructor (not nullable $Delegate_) .NET, .NET Standard 2.0, Cooper, Island-Android, Island-iOS, Island-iOS Simulator-x86_64, Island-macOS-x86_64, Island-tvOS, Island-tvOS Simulator-x86_64, Island-Ubuntu, Island-UIKit for Mac-x86_64, Island-watchOS, Island-watchOS Simulator, Island-Windows

 

constructor(aEntrypoint: not nullable $Delegate_)

 

Thread($Delegate_! aEntrypoint)

 

init(_ aEntrypoint: $Delegate_)

 

Thread($Delegate_! aEntrypoint)

Parameters:

  • aEntrypoint:

constructor (not nullable Action<>) Toffee

Creates a new thread with the given entrypoint. Does not start it until Start is called.

 

init(_ aEntrypoint: () -> ())

Parameters:

  • aEntrypoint:

Abort

Triggers an abort in this thread.

 

method Abort

 

void Abort()

 

func Abort()

 

void Abort()

Async ($Delegate_) .NET, .NET Standard 2.0, Cooper, Island-Android, Island-iOS, Island-iOS Simulator-x86_64, Island-macOS-x86_64, Island-tvOS, Island-tvOS Simulator-x86_64, Island-Ubuntu, Island-UIKit for Mac-x86_64, Island-watchOS, Island-watchOS Simulator, Island-Windows

 

class method Async(aBlock: $Delegate_)

 

static void Async($Delegate_ aBlock)

 

static func Async(_ aBlock: $Delegate_)

 

static void Async($Delegate_ aBlock)

Parameters:

  • aBlock:

Async (Action<>)  virtual Toffee

Run this action async.

 

static func Async(_ aBlock: () -> ())

Parameters:

  • aBlock:

CallStack

Returns the current callstack for this thread.

 

property CallStack: ImmutableList<String> read;

 

ImmutableList<String> CallStack { get; }

 

var CallStack: ImmutableList<String> { get{} }

 

ImmutableList<String> CallStack { __get; }

CurrentCallStack

Returns the current callstack.

 

class property CurrentCallStack: not nullable ImmutableList<String> read;

 

class ImmutableList<String>! CurrentCallStack { get; }

 

static var CurrentCallStack: ImmutableList<String> { get{} }

 

class ImmutableList<String>! CurrentCallStack { __get; }

CurrentThread

Returns the current thread.

 

class property CurrentThread: Thread read;

 

class Thread CurrentThread { get; }

 

static var CurrentThread: Thread { get{} }

 

class Thread CurrentThread { __get; }

IsAlive

True if this thread is still running.

 

property IsAlive: Boolean read;

 

Boolean IsAlive { get; }

 

var IsAlive: Boolean { get{} }

 

Boolean IsAlive { __get; }

Join .NET, .NET Standard 2.0, Cooper, Toffee, ToffeeV2

Wait for this thread to finish.

 

method Join

 

void Join()

 

func Join()

 

void Join()

Join (Int32) .NET, .NET Standard 2.0, Cooper, Toffee, ToffeeV2

Wait for this thread to finish (with a given timeout)

 

method Join(Timeout: Int32)

 

void Join(Int32 Timeout)

 

func Join(_ Timeout: Int32)

 

void Join(Integer Timeout)

Parameters:

  • Timeout:

MainThread Toffee, ToffeeV2

Returns the main thread.

 

static var MainThread: Thread { get{} }

Name

Returns the name of this thread.

 

property Name: String read write;

 

String Name { get; set; }

 

var Name: String { get{} set{} }

 

String Name { __get; __set; }

Priority

Gets/sets the priority of this threa.d

 

property Priority: ThreadPriority read write;

 

ThreadPriority Priority { get; set; }

 

var Priority: ThreadPriority { get{} set{} }

 

ThreadPriority Priority { __get; __set; }

Sleep

Sleep for a given msec.

 

class method Sleep(aTimeout: Int32)

 

static void Sleep(Int32 aTimeout)

 

static func Sleep(_ aTimeout: Int32)

 

static void Sleep(Integer aTimeout)

Parameters:

  • aTimeout:

Start

Start this thread.

 

method Start

 

void Start()

 

func Start()

 

void Start()

ThreadId .NET, .NET Standard 2.0, Cooper, Toffee, ToffeeV2

Returns the thread id.

 

property ThreadId: Int64 read;

 

Int64 ThreadId { get; }

 

// .NET, .NET Standard 2.0
var ThreadId: Int64 { get{} }
// Toffee, ToffeeV2
var ThreadId: IntPtr { get{} }

 

Int64 ThreadId { __get; }

 

CallStack

Returns the current callstack for this thread.

 

property CallStack: ImmutableList<String> read;

 

ImmutableList<String> CallStack { get; }

 

var CallStack: ImmutableList<String> { get{} }

 

ImmutableList<String> CallStack { __get; }

IsAlive

True if this thread is still running.

 

property IsAlive: Boolean read;

 

Boolean IsAlive { get; }

 

var IsAlive: Boolean { get{} }

 

Boolean IsAlive { __get; }

Name

Returns the name of this thread.

 

property Name: String read write;

 

String Name { get; set; }

 

var Name: String { get{} set{} }

 

String Name { __get; __set; }

Priority

Gets/sets the priority of this threa.d

 

property Priority: ThreadPriority read write;

 

ThreadPriority Priority { get; set; }

 

var Priority: ThreadPriority { get{} set{} }

 

ThreadPriority Priority { __get; __set; }

ThreadId .NET, .NET Standard 2.0, Cooper, Toffee, ToffeeV2

Returns the thread id.

 

property ThreadId: Int64 read;

 

Int64 ThreadId { get; }

 

// .NET, .NET Standard 2.0
var ThreadId: Int64 { get{} }
// Toffee, ToffeeV2
var ThreadId: IntPtr { get{} }

 

Int64 ThreadId { __get; }

CurrentCallStack

Returns the current callstack.

 

class property CurrentCallStack: not nullable ImmutableList<String> read;

 

class ImmutableList<String>! CurrentCallStack { get; }

 

static var CurrentCallStack: ImmutableList<String> { get{} }

 

class ImmutableList<String>! CurrentCallStack { __get; }

CurrentThread

Returns the current thread.

 

class property CurrentThread: Thread read;

 

class Thread CurrentThread { get; }

 

static var CurrentThread: Thread { get{} }

 

class Thread CurrentThread { __get; }

MainThread Toffee, ToffeeV2

Returns the main thread.

 

static var MainThread: Thread { get{} }

 

Async ($Delegate_) .NET, .NET Standard 2.0, Cooper, Island-Android, Island-iOS, Island-iOS Simulator-x86_64, Island-macOS-x86_64, Island-tvOS, Island-tvOS Simulator-x86_64, Island-Ubuntu, Island-UIKit for Mac-x86_64, Island-watchOS, Island-watchOS Simulator, Island-Windows

 

class method Async(aBlock: $Delegate_)

 

static void Async($Delegate_ aBlock)

 

static func Async(_ aBlock: $Delegate_)

 

static void Async($Delegate_ aBlock)

Parameters:

  • aBlock:

Async (Action<>)  virtual Toffee

Run this action async.

 

static func Async(_ aBlock: () -> ())

Parameters:

  • aBlock:

Sleep

Sleep for a given msec.

 

class method Sleep(aTimeout: Int32)

 

static void Sleep(Int32 aTimeout)

 

static func Sleep(_ aTimeout: Int32)

 

static void Sleep(Integer aTimeout)

Parameters:

  • aTimeout:

 

constructor (not nullable $Delegate_) .NET, .NET Standard 2.0, Cooper, Island-Android, Island-iOS, Island-iOS Simulator-x86_64, Island-macOS-x86_64, Island-tvOS, Island-tvOS Simulator-x86_64, Island-Ubuntu, Island-UIKit for Mac-x86_64, Island-watchOS, Island-watchOS Simulator, Island-Windows

 

constructor(aEntrypoint: not nullable $Delegate_)

 

Thread($Delegate_! aEntrypoint)

 

init(_ aEntrypoint: $Delegate_)

 

Thread($Delegate_! aEntrypoint)

Parameters:

  • aEntrypoint:

constructor (not nullable Action<>) Toffee

Creates a new thread with the given entrypoint. Does not start it until Start is called.

 

init(_ aEntrypoint: () -> ())

Parameters:

  • aEntrypoint:

Abort

Triggers an abort in this thread.

 

method Abort

 

void Abort()

 

func Abort()

 

void Abort()

Join .NET, .NET Standard 2.0, Cooper, Toffee, ToffeeV2

Wait for this thread to finish.

 

method Join

 

void Join()

 

func Join()

 

void Join()

Join (Int32) .NET, .NET Standard 2.0, Cooper, Toffee, ToffeeV2

Wait for this thread to finish (with a given timeout)

 

method Join(Timeout: Int32)

 

void Join(Int32 Timeout)

 

func Join(_ Timeout: Int32)

 

void Join(Integer Timeout)

Parameters:

  • Timeout:

Start

Start this thread.

 

method Start

 

void Start()

 

func Start()

 

void Start()