Task<T>
Overview
Task class that returns a value.
Location
- Reference: Island.fx
- Namespace: RemObjects.Elements.System
- Ancestry: Task | Task<T>
constructor (declared in Object)
constructor
Task<T>()
init()
Task<T>()
Sub New()
constructor (Action) (declared in Task)
constructor(aIn: Action)
Task<T>(Action aIn)
init(_ aIn: Action)
Task<T>(Action aIn)
Sub New(aIn As Action)
Parameters:
- aIn:
constructor(aIn: Action<RemObjects.Elements.System.Object>; aState: Object)
Task<T>(Action<RemObjects.Elements.System.Object> aIn, Object aState)
init(_ aIn: Action<RemObjects.Elements.System.Object>, _ aState: Object)
Task<T>(Action<RemObjects.Elements.System.Object> aIn, Object aState)
Sub New(aIn As Action<RemObjects.Elements.System.Object>, aState As Object)
Parameters:
- aIn:
- aState:
constructor (Func<T>)
constructor(aIn: Func<T>)
Task<T>(Func<T> aIn)
init(_ aIn: Func<T>)
Task<T>(Func<T> aIn)
Sub New(aIn As Func<T>)
Parameters:
- aIn:
constructor (Func<RemObjects.Elements.System.Object,T>, Object)
constructor(aIn: Func<RemObjects.Elements.System.Object,T>; aState: Object)
Task<T>(Func<RemObjects.Elements.System.Object,T> aIn, Object aState)
init(_ aIn: Func<RemObjects.Elements.System.Object,T>, _ aState: Object)
Task<T>(Func<RemObjects.Elements.System.Object,T> aIn, Object aState)
Sub New(aIn As Func<RemObjects.Elements.System.Object,T>, aState As Object)
Parameters:
- aIn:
- aState:
Await (declared in Task)
Adds to this tasks await completion list, runs this interface when done, or returns true if it's already done.
method Await(aCompletion: IAwaitCompletion): Boolean
Boolean Await(IAwaitCompletion aCompletion)
func Await(_ aCompletion: IAwaitCompletion) -> Boolean
Boolean Await(IAwaitCompletion aCompletion)
Function Await(aCompletion As IAwaitCompletion) As Boolean
Parameters:
- aCompletion:
CompletedTask (declared in Task)
class property CompletedTask: Task read;
class Task CompletedTask { get; }
static var CompletedTask: Task { get{} }
class Task CompletedTask { __get; }
Shared ReadOnly Property CompletedTask() As Task
ConfigureAwait (Boolean): ConfiguredAwaitTask (declared in Task)
Defines if awaiting this task should return to the current context or not.
method ConfigureAwait(aCaptureContext: Boolean): ConfiguredAwaitTask
ConfiguredAwaitTask ConfigureAwait(Boolean aCaptureContext)
func ConfigureAwait(_ aCaptureContext: Boolean) -> ConfiguredAwaitTask
ConfiguredAwaitTask ConfigureAwait(Boolean aCaptureContext)
Function ConfigureAwait(aCaptureContext As Boolean) As ConfiguredAwaitTask
Parameters:
- aCaptureContext:
ConfigureAwait (Boolean): ConfiguredAwaitTask<T>
Defines if awaiting this task should return to the current context or not.
method ConfigureAwait(aCaptureContext: Boolean): ConfiguredAwaitTask<T>
ConfiguredAwaitTask<T> ConfigureAwait(Boolean aCaptureContext)
func ConfigureAwait(_ aCaptureContext: Boolean) -> ConfiguredAwaitTask<T>
ConfiguredAwaitTask<T> ConfigureAwait(Boolean aCaptureContext)
Function ConfigureAwait(aCaptureContext As Boolean) As ConfiguredAwaitTask<T>
Parameters:
- aCaptureContext:
Continue this task with the given callback when it's done.
method ContinueWith(aAction: Action<RemObjects.Elements.System.Task>): Task
Task ContinueWith(Action<RemObjects.Elements.System.Task> aAction)
func ContinueWith(_ aAction: Action<RemObjects.Elements.System.Task>) -> Task
Task ContinueWith(Action<RemObjects.Elements.System.Task> aAction)
Function ContinueWith(aAction As Action<RemObjects.Elements.System.Task>) As Task
Parameters:
- aAction:
ContinueWith (Action<RemObjects.Elements.System.Task,RemObjects.Elements.System.Object>, Object): Task (declared in Task)
Continue this task with the given callback when it's done.
method ContinueWith(aAction: Action<RemObjects.Elements.System.Task,RemObjects.Elements.System.Object>; aState: Object): Task
Task ContinueWith(Action<RemObjects.Elements.System.Task,RemObjects.Elements.System.Object> aAction, Object aState)
func ContinueWith(_ aAction: Action<RemObjects.Elements.System.Task,RemObjects.Elements.System.Object>, _ aState: Object) -> Task
Parameters:
- aAction:
- aState:
Continue this task with the given callback when it's done.
method ContinueWith<T>(aAction: Func<RemObjects.Elements.System.Task,T>): Task<T>
Task<T> ContinueWith<T>(Func<RemObjects.Elements.System.Task,T> aAction)
func ContinueWith<T>(_ aAction: Func<RemObjects.Elements.System.Task,T>) -> Task<T>
Task<T> ContinueWith<T>(Func<RemObjects.Elements.System.Task,T> aAction)
Function ContinueWith<T>(aAction As Func<RemObjects.Elements.System.Task,T>) As Task<T>
Parameters:
- aAction:
ContinueWith<T> (Func<RemObjects.Elements.System.Task,RemObjects.Elements.System.Object,T>, Object): Task<T> (declared in Task)
Continue this task with the given callback when it's done.
method ContinueWith<T>(aAction: Func<RemObjects.Elements.System.Task,RemObjects.Elements.System.Object,T>; aState: Object): Task<T>
Task<T> ContinueWith<T>(Func<RemObjects.Elements.System.Task,RemObjects.Elements.System.Object,T> aAction, Object aState)
func ContinueWith<T>(_ aAction: Func<RemObjects.Elements.System.Task,RemObjects.Elements.System.Object,T>, _ aState: Object) -> Task<T>
Parameters:
- aAction:
- aState:
Equals virtual (declared in Object)
Default constructor.
Parameters:
- aOther: the reference to compare this with.
Exception (declared in Task)
Returns the exception that occurred.
property Exception: Exception read;
Exception Exception { get; }
var Exception: Exception { get{} }
Exception Exception { __get; }
ReadOnly Property Exception() As Exception
Finalize protected virtual (declared in Object)
method Finalize
void Finalize()
func Finalize()
void Finalize()
Sub Finalize()
FromResult<T> (declared in Task)
class method FromResult<T>(x: T): Task<T>
static Task<T> FromResult<T>(T x)
static func FromResult<T>(_ x: T) -> Task<T>
static Task<T> FromResult<T>(T x)
Shared Function FromResult<T>(x As T) As Task<T>
Parameters:
- x:
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
GetValue
method GetValue: Object
Object GetValue()
func GetValue() -> Object
Object GetValue()
Function GetValue() As Object
IsCompleted (declared in Task)
True if the task is done (or failed)
property IsCompleted: Boolean read;
Boolean IsCompleted { get; }
var IsCompleted: Boolean { get{} }
Boolean IsCompleted { __get; }
ReadOnly Property IsCompleted() As Boolean
IsFaulted (declared in Task)
Returns true if the task threw an exception.
property IsFaulted: Boolean read;
Boolean IsFaulted { get; }
var IsFaulted: Boolean { get{} }
Boolean IsFaulted { __get; }
ReadOnly Property IsFaulted() As Boolean
IsStarted (declared in Task)
Returns true if the task started.
property IsStarted: Boolean read;
Boolean IsStarted { get; }
var IsStarted: Boolean { get{} }
Boolean IsStarted { __get; }
ReadOnly Property IsStarted() As Boolean
ReferenceEquals (declared in Object)
Compares two references for equivalence (even if they have an equals operator)
Parameters:
- a: left value
- b: right value
Result
Returns the result of this task; blocks if not done.
property Result: T read;
T Result { get; }
var Result: T { get{} }
T Result { __get; }
ReadOnly Property Result() As T
Runs the given callback and returns a task.
class method Run(aIn: Action): Task
static Task Run(Action aIn)
static func Run(_ aIn: Action) -> Task
static Task Run(Action aIn)
Shared Function Run(aIn As Action) As Task
Parameters:
- aIn:
Runs the given callback and returns a task.
Parameters:
- aIn:
- aValue:
Runs the given callback and returns a task.
class method Run<T>(aIn: Func<T>): Task<T>
static Task<T> Run<T>(Func<T> aIn)
static func Run<T>(_ aIn: Func<T>) -> Task<T>
static Task<T> Run<T>(Func<T> aIn)
Shared Function Run<T>(aIn As Func<T>) As Task<T>
Parameters:
- aIn:
Runs the given callback and returns a task.
Parameters:
- aIn:
- aValue:
Runs the given callback in the context of the caller and returns a task.
class method RunSynchronous(aIn: Action): Task
static Task RunSynchronous(Action aIn)
static func RunSynchronous(_ aIn: Action) -> Task
static Task RunSynchronous(Action aIn)
Shared Function RunSynchronous(aIn As Action) As Task
Parameters:
- aIn:
Runs the given callback in the context of the caller and returns a task.
Parameters:
- aIn:
- aValue:
Runs the given callback in the context of the caller and returns a task.
class method RunSynchronous<T>(aIn: Func<T>): Task<T>
static Task<T> RunSynchronous<T>(Func<T> aIn)
static func RunSynchronous<T>(_ aIn: Func<T>) -> Task<T>
static Task<T> RunSynchronous<T>(Func<T> aIn)
Shared Function RunSynchronous<T>(aIn As Func<T>) As Task<T>
Parameters:
- aIn:
Runs the given callback in the context of the caller and returns a task.
class method RunSynchronous<T>(aIn: Func<RemObjects.Elements.System.Object,T>; aValue: Object): Task<T>
Parameters:
- aIn:
- aValue:
Start (declared in Task)
method Start
void Start()
func Start()
void Start()
Sub Start()
State (declared in Task)
Returns the state of this task.
property State: TaskState read;
TaskState State { get; }
var State: TaskState { get{} }
TaskState State { __get; }
ReadOnly Property State() As TaskState
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 virtual (declared in Task)
method Wait
void Wait()
func Wait()
void Wait()
Sub Wait()
Waits for the task to finish or timeout.
Parameters:
- aTimeoutMSec:
Exception (declared in Task)
Returns the exception that occurred.
property Exception: Exception read;
Exception Exception { get; }
var Exception: Exception { get{} }
Exception Exception { __get; }
ReadOnly Property Exception() As Exception
IsCompleted (declared in Task)
True if the task is done (or failed)
property IsCompleted: Boolean read;
Boolean IsCompleted { get; }
var IsCompleted: Boolean { get{} }
Boolean IsCompleted { __get; }
ReadOnly Property IsCompleted() As Boolean
IsFaulted (declared in Task)
Returns true if the task threw an exception.
property IsFaulted: Boolean read;
Boolean IsFaulted { get; }
var IsFaulted: Boolean { get{} }
Boolean IsFaulted { __get; }
ReadOnly Property IsFaulted() As Boolean
IsStarted (declared in Task)
Returns true if the task started.
property IsStarted: Boolean read;
Boolean IsStarted { get; }
var IsStarted: Boolean { get{} }
Boolean IsStarted { __get; }
ReadOnly Property IsStarted() As Boolean
Result
Returns the result of this task; blocks if not done.
property Result: T read;
T Result { get; }
var Result: T { get{} }
T Result { __get; }
ReadOnly Property Result() As T
State (declared in Task)
Returns the state of this task.
property State: TaskState read;
TaskState State { get; }
var State: TaskState { get{} }
TaskState State { __get; }
ReadOnly Property State() As TaskState
CompletedTask (declared in Task)
FromResult<T> (declared in Task)
class method FromResult<T>(x: T): Task<T>
static Task<T> FromResult<T>(T x)
static func FromResult<T>(_ x: T) -> Task<T>
static Task<T> FromResult<T>(T x)
Shared Function FromResult<T>(x As T) As Task<T>
Parameters:
- x:
ReferenceEquals (declared in Object)
Compares two references for equivalence (even if they have an equals operator)
Parameters:
- a: left value
- b: right value
Runs the given callback and returns a task.
class method Run(aIn: Action): Task
static Task Run(Action aIn)
static func Run(_ aIn: Action) -> Task
static Task Run(Action aIn)
Shared Function Run(aIn As Action) As Task
Parameters:
- aIn:
Runs the given callback and returns a task.
Parameters:
- aIn:
- aValue:
Runs the given callback and returns a task.
class method Run<T>(aIn: Func<T>): Task<T>
static Task<T> Run<T>(Func<T> aIn)
static func Run<T>(_ aIn: Func<T>) -> Task<T>
static Task<T> Run<T>(Func<T> aIn)
Shared Function Run<T>(aIn As Func<T>) As Task<T>
Parameters:
- aIn:
Runs the given callback and returns a task.
Parameters:
- aIn:
- aValue:
Runs the given callback in the context of the caller and returns a task.
class method RunSynchronous(aIn: Action): Task
static Task RunSynchronous(Action aIn)
static func RunSynchronous(_ aIn: Action) -> Task
static Task RunSynchronous(Action aIn)
Shared Function RunSynchronous(aIn As Action) As Task
Parameters:
- aIn:
Runs the given callback in the context of the caller and returns a task.
Parameters:
- aIn:
- aValue:
Runs the given callback in the context of the caller and returns a task.
class method RunSynchronous<T>(aIn: Func<T>): Task<T>
static Task<T> RunSynchronous<T>(Func<T> aIn)
static func RunSynchronous<T>(_ aIn: Func<T>) -> Task<T>
static Task<T> RunSynchronous<T>(Func<T> aIn)
Shared Function RunSynchronous<T>(aIn As Func<T>) As Task<T>
Parameters:
- aIn:
Runs the given callback in the context of the caller and returns a task.
class method RunSynchronous<T>(aIn: Func<RemObjects.Elements.System.Object,T>; aValue: Object): Task<T>
Parameters:
- aIn:
- aValue:
constructor (declared in Object)
constructor
Task<T>()
init()
Task<T>()
Sub New()
constructor (Action) (declared in Task)
constructor(aIn: Action)
Task<T>(Action aIn)
init(_ aIn: Action)
Task<T>(Action aIn)
Sub New(aIn As Action)
Parameters:
- aIn:
constructor(aIn: Action<RemObjects.Elements.System.Object>; aState: Object)
Task<T>(Action<RemObjects.Elements.System.Object> aIn, Object aState)
init(_ aIn: Action<RemObjects.Elements.System.Object>, _ aState: Object)
Task<T>(Action<RemObjects.Elements.System.Object> aIn, Object aState)
Sub New(aIn As Action<RemObjects.Elements.System.Object>, aState As Object)
Parameters:
- aIn:
- aState:
constructor (Func<T>)
constructor(aIn: Func<T>)
Task<T>(Func<T> aIn)
init(_ aIn: Func<T>)
Task<T>(Func<T> aIn)
Sub New(aIn As Func<T>)
Parameters:
- aIn:
constructor (Func<RemObjects.Elements.System.Object,T>, Object)
constructor(aIn: Func<RemObjects.Elements.System.Object,T>; aState: Object)
Task<T>(Func<RemObjects.Elements.System.Object,T> aIn, Object aState)
init(_ aIn: Func<RemObjects.Elements.System.Object,T>, _ aState: Object)
Task<T>(Func<RemObjects.Elements.System.Object,T> aIn, Object aState)
Sub New(aIn As Func<RemObjects.Elements.System.Object,T>, aState As Object)
Parameters:
- aIn:
- aState:
Await (declared in Task)
Adds to this tasks await completion list, runs this interface when done, or returns true if it's already done.
method Await(aCompletion: IAwaitCompletion): Boolean
Boolean Await(IAwaitCompletion aCompletion)
func Await(_ aCompletion: IAwaitCompletion) -> Boolean
Boolean Await(IAwaitCompletion aCompletion)
Function Await(aCompletion As IAwaitCompletion) As Boolean
Parameters:
- aCompletion:
ConfigureAwait (Boolean): ConfiguredAwaitTask (declared in Task)
Defines if awaiting this task should return to the current context or not.
method ConfigureAwait(aCaptureContext: Boolean): ConfiguredAwaitTask
ConfiguredAwaitTask ConfigureAwait(Boolean aCaptureContext)
func ConfigureAwait(_ aCaptureContext: Boolean) -> ConfiguredAwaitTask
ConfiguredAwaitTask ConfigureAwait(Boolean aCaptureContext)
Function ConfigureAwait(aCaptureContext As Boolean) As ConfiguredAwaitTask
Parameters:
- aCaptureContext:
ConfigureAwait (Boolean): ConfiguredAwaitTask<T>
Defines if awaiting this task should return to the current context or not.
method ConfigureAwait(aCaptureContext: Boolean): ConfiguredAwaitTask<T>
ConfiguredAwaitTask<T> ConfigureAwait(Boolean aCaptureContext)
func ConfigureAwait(_ aCaptureContext: Boolean) -> ConfiguredAwaitTask<T>
ConfiguredAwaitTask<T> ConfigureAwait(Boolean aCaptureContext)
Function ConfigureAwait(aCaptureContext As Boolean) As ConfiguredAwaitTask<T>
Parameters:
- aCaptureContext:
Continue this task with the given callback when it's done.
method ContinueWith(aAction: Action<RemObjects.Elements.System.Task>): Task
Task ContinueWith(Action<RemObjects.Elements.System.Task> aAction)
func ContinueWith(_ aAction: Action<RemObjects.Elements.System.Task>) -> Task
Task ContinueWith(Action<RemObjects.Elements.System.Task> aAction)
Function ContinueWith(aAction As Action<RemObjects.Elements.System.Task>) As Task
Parameters:
- aAction:
ContinueWith (Action<RemObjects.Elements.System.Task,RemObjects.Elements.System.Object>, Object): Task (declared in Task)
Continue this task with the given callback when it's done.
method ContinueWith(aAction: Action<RemObjects.Elements.System.Task,RemObjects.Elements.System.Object>; aState: Object): Task
Task ContinueWith(Action<RemObjects.Elements.System.Task,RemObjects.Elements.System.Object> aAction, Object aState)
func ContinueWith(_ aAction: Action<RemObjects.Elements.System.Task,RemObjects.Elements.System.Object>, _ aState: Object) -> Task
Parameters:
- aAction:
- aState:
Continue this task with the given callback when it's done.
method ContinueWith<T>(aAction: Func<RemObjects.Elements.System.Task,T>): Task<T>
Task<T> ContinueWith<T>(Func<RemObjects.Elements.System.Task,T> aAction)
func ContinueWith<T>(_ aAction: Func<RemObjects.Elements.System.Task,T>) -> Task<T>
Task<T> ContinueWith<T>(Func<RemObjects.Elements.System.Task,T> aAction)
Function ContinueWith<T>(aAction As Func<RemObjects.Elements.System.Task,T>) As Task<T>
Parameters:
- aAction:
ContinueWith<T> (Func<RemObjects.Elements.System.Task,RemObjects.Elements.System.Object,T>, Object): Task<T> (declared in Task)
Continue this task with the given callback when it's done.
method ContinueWith<T>(aAction: Func<RemObjects.Elements.System.Task,RemObjects.Elements.System.Object,T>; aState: Object): Task<T>
Task<T> ContinueWith<T>(Func<RemObjects.Elements.System.Task,RemObjects.Elements.System.Object,T> aAction, Object aState)
func ContinueWith<T>(_ aAction: Func<RemObjects.Elements.System.Task,RemObjects.Elements.System.Object,T>, _ aState: Object) -> Task<T>
Parameters:
- aAction:
- aState:
Equals virtual (declared in Object)
Default constructor.
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
GetValue
method GetValue: Object
Object GetValue()
func GetValue() -> Object
Object GetValue()
Function GetValue() As Object
Start (declared in Task)
method Start
void Start()
func Start()
void Start()
Sub Start()
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 virtual (declared in Task)
method Wait
void Wait()
func Wait()
void Wait()
Sub Wait()
Waits for the task to finish or timeout.
Parameters:
- aTimeoutMSec: