Thread
Overview
Class for multithreaded code
Location
-
Reference:
- Elements.dll .NET, .NET Standard 2.0
- Elements.fx Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-watchOS, Island-watchOS Simulator, Island-Windows, ToffeeV2
- libElements.fx Toffee
- Namespace: RemObjects.Elements.RTL
- Platforms: .NET, .NET Standard 2.0, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-watchOS, Island-watchOS Simulator, Island-Windows, Toffee, ToffeeV2
-
Mapped to:
- Thread .NET, .NET Standard 2.0
- Thread Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-watchOS, Island-watchOS Simulator, Island-Windows
- NSThread Toffee, ToffeeV2
constructor (not nullable Action) .NET, .NET Standard 2.0, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-watchOS, Island-watchOS Simulator, Island-Windows
Creates a new thread with the given entrypoint. Does not start it until Start is called.
constructor(aEntrypoint: not nullable Action)
Thread(Action! aEntrypoint)
init(_ aEntrypoint: Action)
Sub New(aEntrypoint As Action)
Parameters:
- aEntrypoint:
constructor (not nullable block()) Toffee
Creates a new thread with the given entrypoint. Does not start it until Start is called.
init(_ aEntrypoint: () -> ())
Parameters:
- aEntrypoint:
constructor (not nullable Block) ToffeeV2
init(_ aEntrypoint: Block)
Parameters:
- aEntrypoint:
Abort .NET, .NET Standard 2.0, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-watchOS, Island-watchOS Simulator, Island-Windows, ToffeeV2
Triggers an abort in this thread.
method Abort
void Abort()
func Abort()
Sub Abort()
Abort Abort() virtual Toffee
func Abort(Abort )
Parameters:
- :
Async (Action) .NET, .NET Standard 2.0, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-watchOS, Island-watchOS Simulator, Island-Windows
Run this action async.
class method Async(aBlock: Action)
static void Async(Action aBlock)
static func Async(_ aBlock: Action)
Shared Sub Async(aBlock As Action)
Parameters:
- aBlock:
Async (block()) virtual Toffee
Run this action async.
static func Async(_ aBlock: () -> ())
Parameters:
- aBlock:
Async (Block) ToffeeV2
static func Async(_ aBlock: Block)
Parameters:
- aBlock:
CallStack
Returns the current callstack for this thread.
property CallStack: ImmutableList<String> read;
ImmutableList<String> CallStack { get; }
var CallStack: ImmutableList<String> { get{} }
ReadOnly Property CallStack() As ImmutableList<String>
CurrentCallStack
Returns the current callstack.
class property CurrentCallStack: not nullable ImmutableList<String> read;
class ImmutableList<String>! CurrentCallStack { get; }
static var CurrentCallStack: ImmutableList<String> { get{} }
Shared ReadOnly Property CurrentCallStack() As ImmutableList<String>
CurrentThread
Returns the current thread.
class property CurrentThread: Thread read;
class Thread CurrentThread { get; }
static var CurrentThread: Thread { get{} }
Shared ReadOnly Property CurrentThread() As Thread
IsAlive
True if this thread is still running.
property IsAlive: Boolean read;
Boolean IsAlive { get; }
var IsAlive: Boolean { get{} }
ReadOnly Property IsAlive() As Boolean
Join .NET, .NET Standard 2.0, Toffee, ToffeeV2
Wait for this thread to finish.
method Join
void Join()
func Join()
Sub Join()
Join (Int32) .NET, .NET Standard 2.0, Toffee, ToffeeV2
Wait for this thread to finish (with a given timeout)
method Join(Timeout: Int32)
void Join(Int32 Timeout)
func Join(_ Timeout: Int32)
Sub Join(Timeout As Int32)
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{} }
Property Name() As String
Priority Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-watchOS, Island-watchOS Simulator, Island-Windows, Toffee, ToffeeV2
Gets/sets the priority of this threa.d
property Priority: ThreadPriority read write;
ThreadPriority Priority { get; set; }
var Priority: ThreadPriority { get{} set{} }
Property Priority() As ThreadPriority
Priority .NET, .NET Standard 2.0
property Priority: ThreadPriority read write;
ThreadPriority Priority { get; set; }
var Priority: ThreadPriority { get{} set{} }
Property Priority() As ThreadPriority
Sleep
Sleep for a given msec.
class method Sleep(aTimeout: Int32)
static void Sleep(Int32 aTimeout)
static func Sleep(_ aTimeout: Int32)
Shared Sub Sleep(aTimeout As Int32)
Parameters:
- aTimeout:
Start .NET, .NET Standard 2.0, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-watchOS, Island-watchOS Simulator, Island-Windows, ToffeeV2
Start this thread.
method Start
void Start()
func Start()
Sub Start()
Start Start() virtual Toffee
func Start(Start )
Parameters:
- :
ThreadId .NET, .NET Standard 2.0
Returns the thread id.
property ThreadId: Int64 read;
Int64 ThreadId { get; }
var ThreadId: Int64 { get{} }
ReadOnly Property ThreadId() As Int64
ThreadId Toffee, ToffeeV2
var ThreadId: IntPtr { get{} }
CallStack
Returns the current callstack for this thread.
property CallStack: ImmutableList<String> read;
ImmutableList<String> CallStack { get; }
var CallStack: ImmutableList<String> { get{} }
ReadOnly Property CallStack() As ImmutableList<String>
IsAlive
True if this thread is still running.
property IsAlive: Boolean read;
Boolean IsAlive { get; }
var IsAlive: Boolean { get{} }
ReadOnly Property IsAlive() As Boolean
Name
Returns the name of this thread.
property Name: String read write;
String Name { get; set; }
var Name: String { get{} set{} }
Property Name() As String
Priority Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-watchOS, Island-watchOS Simulator, Island-Windows, Toffee, ToffeeV2
Gets/sets the priority of this threa.d
property Priority: ThreadPriority read write;
ThreadPriority Priority { get; set; }
var Priority: ThreadPriority { get{} set{} }
Property Priority() As ThreadPriority
ThreadId .NET, .NET Standard 2.0
Returns the thread id.
property ThreadId: Int64 read;
Int64 ThreadId { get; }
var ThreadId: Int64 { get{} }
ReadOnly Property ThreadId() As Int64
ThreadId Toffee, ToffeeV2
var ThreadId: IntPtr { 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{} }
Shared ReadOnly Property CurrentCallStack() As ImmutableList<String>
CurrentThread
Returns the current thread.
class property CurrentThread: Thread read;
class Thread CurrentThread { get; }
static var CurrentThread: Thread { get{} }
Shared ReadOnly Property CurrentThread() As Thread
MainThread Toffee, ToffeeV2
Returns the main thread.
static var MainThread: Thread { get{} }
Priority .NET, .NET Standard 2.0
property Priority: ThreadPriority read write;
ThreadPriority Priority { get; set; }
var Priority: ThreadPriority { get{} set{} }
Property Priority() As ThreadPriority
Async (Action) .NET, .NET Standard 2.0, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-watchOS, Island-watchOS Simulator, Island-Windows
Run this action async.
class method Async(aBlock: Action)
static void Async(Action aBlock)
static func Async(_ aBlock: Action)
Shared Sub Async(aBlock As Action)
Parameters:
- aBlock:
Async (block()) virtual Toffee
Run this action async.
static func Async(_ aBlock: () -> ())
Parameters:
- aBlock:
Async (Block) ToffeeV2
static func Async(_ aBlock: Block)
Parameters:
- aBlock:
Sleep
Sleep for a given msec.
class method Sleep(aTimeout: Int32)
static void Sleep(Int32 aTimeout)
static func Sleep(_ aTimeout: Int32)
Shared Sub Sleep(aTimeout As Int32)
Parameters:
- aTimeout:
constructor (not nullable Action) .NET, .NET Standard 2.0, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-watchOS, Island-watchOS Simulator, Island-Windows
Creates a new thread with the given entrypoint. Does not start it until Start is called.
constructor(aEntrypoint: not nullable Action)
Thread(Action! aEntrypoint)
init(_ aEntrypoint: Action)
Sub New(aEntrypoint As Action)
Parameters:
- aEntrypoint:
constructor (not nullable block()) Toffee
Creates a new thread with the given entrypoint. Does not start it until Start is called.
init(_ aEntrypoint: () -> ())
Parameters:
- aEntrypoint:
constructor (not nullable Block) ToffeeV2
init(_ aEntrypoint: Block)
Parameters:
- aEntrypoint:
Abort .NET, .NET Standard 2.0, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-watchOS, Island-watchOS Simulator, Island-Windows, ToffeeV2
Triggers an abort in this thread.
method Abort
void Abort()
func Abort()
Sub Abort()
Abort Abort() virtual Toffee
func Abort(Abort )
Parameters:
- :
Join .NET, .NET Standard 2.0, Toffee, ToffeeV2
Wait for this thread to finish.
method Join
void Join()
func Join()
Sub Join()
Join (Int32) .NET, .NET Standard 2.0, Toffee, ToffeeV2
Wait for this thread to finish (with a given timeout)
method Join(Timeout: Int32)
void Join(Int32 Timeout)
func Join(_ Timeout: Int32)
Sub Join(Timeout As Int32)
Parameters:
- Timeout:
Start .NET, .NET Standard 2.0, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-watchOS, Island-watchOS Simulator, Island-Windows, ToffeeV2
Start this thread.
method Start
void Start()
func Start()
Sub Start()
Start Start() virtual Toffee
func Start(Start )
Parameters:
- :