OVRTask Class

Indicates whether the task has completed.

Whether the task completed due to an unhandled exception.

Whether there is a result available.

( IEnumerable< OVRTask< TResult > > tasks )

Creates a task that completes when all of the supplied tasks have completed.

( IEnumerable< OVRTask< TResult > > tasks,

List< TResult > results )

Creates a task that completes when all of the supplied tasks have completed.

( TResult result )

Creates an already-complete task.

( Guid id,

TResult result )

Sets the result of a pending task.

( Guid taskId )

Creates a new task.

( OVRTask< TResult > lhs,

OVRTask< TResult > rhs )

( OVRTask< TResult > lhs,

OVRTask< TResult > rhs )

( OVRTask< T1 > task1,

OVRTask< T2 > task2 )

Creates a new task that will complete when all of the given tasks have completed.

( OVRTask< T1 > task1,

OVRTask< T2 > task2,

OVRTask< T3 > task3 )

Creates a new task that will complete when all of the given tasks have completed.

( OVRTask< T1 > task1,

OVRTask< T2 > task2,

OVRTask< T3 > task3,

OVRTask< T4 > task4 )

Creates a new task that will complete when all of the given tasks have completed.

( OVRTask< T1 > task1,

OVRTask< T2 > task2,

OVRTask< T3 > task3,

OVRTask< T4 > task4,

OVRTask< T5 > task5 )

Creates a new task that will complete when all of the given tasks have completed.

( OVRTask< T1 > task1,

OVRTask< T2 > task2,

OVRTask< T3 > task3,

OVRTask< T4 > task4,

OVRTask< T5 > task5,

OVRTask< T6 > task6 )

Creates a new task that will complete when all of the given tasks have completed.

( OVRTask< T1 > task1,

OVRTask< T2 > task2,

OVRTask< T3 > task3,

OVRTask< T4 > task4,

OVRTask< T5 > task5,

OVRTask< T6 > task6,

OVRTask< T7 > task7 )

Creates a new task that will complete when all of the given tasks have completed.

( OVRTask< T1 > task1,

OVRTask< T2 > task2,

OVRTask< T3 > task3,

OVRTask< T4 > task4,

OVRTask< T5 > task5,

OVRTask< T6 > task6,

OVRTask< T7 > task7,

OVRTask< T8 > task8 )

Creates a new task that will complete when all of the given tasks have completed.

Removes internal data related to the task.

Get the exception if the task is in a faulted state.

Gets the result of the asynchronous operation.

( out TResult result )

Tries to get the result of the asynchronous operation.

Converts the task to a ValueTask.

Gets an awaiter that satisfies the await contract.

( Action< TResult > onCompleted )

Registers a delegate to be invoked on completion of the task.

( Action< TResult, T > onCompleted,

T state )

Registers a delegate that will get called on completion of the task.

( object @ delegate,

string paramName )

Disposes of the task.

( OVRTask< TResult > other )

( object obj )

Indicates whether the task has completed.

Choose only one pattern out of the three proposed way of awaiting for the task completion: Polling,async/await or ContinueWith(Action<TResult>) as all three patterns will end up calling the GetResult which can only be called once.

Whether the task completed due to an unhandled exception.

If the task is in a faulted state, then you can extract the exception with GetException.

Whether there is a result available.

This property is true when the OVRTask<TResult> is complete (IsCompleted is true) and GetResult has not already been called.

Note that GetResult is called implicitly when using await or ContinueWith.

Creates a task that completes when all of the supplied tasks have completed.

This can be used to combine multiple tasks into a single task. The returned task completes when all tasks in tasks complete.

The result of the returned task is an array containing the results of each individual task. The results are arranged in the same order as the original tasks list.

Creates a task that completes when all of the supplied tasks have completed.

This can be used to combine multiple tasks into a single task. The returned task completes when all tasks in tasks complete.

The result of each task in tasks is added to results . The results are in the same order as tasks .

The list in the combined task is a reference to results . This allows the caller to own (and potentially reuse) the memory for the list of results. It is undefined behavior to access results before the returned task completes.

Creates an already-complete task.

This creates a completed task whose result is result .

Sets the result of a pending task.

Set the result of a task previously created with Create<TResult>. When this method returns, OVRTask<TResult>.IsCompleted will be true.

This allows you to await on MyOpAsync:

Creates a new task.

This method creates a new pending task. When the task completes, set its result with SetResult<TResult>.

The returned task is in a pending state; that is, OVRTask<TResult>.IsCompleted is False until you later set its result with SetResult<TResult>.

The taskId must be unique to the new task. You may use any Guid as long as it has not previously been used to create a task. Use to generate a random task id.

Creates a new task that will complete when all of the given tasks have completed.

This method can be used to combine multiple tasks into a single task that depends on all of them. When the returned task completes, the results of all combined tasks can be accessed through the result of the returned task. The type of the result is a tuple containing the result types of each input task, that is

For example,

Creates a new task that will complete when all of the given tasks have completed.

This method can be used to combine multiple tasks into a single task that depends on all of them. When the returned task completes, the results of all combined tasks can be accessed through the result of the returned task. The type of the result is a tuple containing the result types of each input task, that is

For example,

Creates a new task that will complete when all of the given tasks have completed.

This method can be used to combine multiple tasks into a single task that depends on all of them. When the returned task completes, the results of all combined tasks can be accessed through the result of the returned task. The type of the result is a tuple containing the result types of each input task, that is

For example,

Creates a new task that will complete when all of the given tasks have completed.

This method can be used to combine multiple tasks into a single task that depends on all of them. When the returned task completes, the results of all combined tasks can be accessed through the result of the returned task. The type of the result is a tuple containing the result types of each input task, that is

For example,

Creates a new task that will complete when all of the given tasks have completed.

This method can be used to combine multiple tasks into a single task that depends on all of them. When the returned task completes, the results of all combined tasks can be accessed through the result of the returned task. The type of the result is a tuple containing the result types of each input task, that is

For example,

Creates a new task that will complete when all of the given tasks have completed.

This method can be used to combine multiple tasks into a single task that depends on all of them. When the returned task completes, the results of all combined tasks can be accessed through the result of the returned task. The type of the result is a tuple containing the result types of each input task, that is

For example,

Creates a new task that will complete when all of the given tasks have completed.

This method can be used to combine multiple tasks into a single task that depends on all of them. When the returned task completes, the results of all combined tasks can be accessed through the result of the returned task. The type of the result is a tuple containing the result types of each input task, that is

For example,

Removes internal data related to the task.

Removes incremental result subscribers and internal data. Call this when the task completes.

Get the exception if the task is in a faulted state.

If IsFaulted is True, then this method gets the exception associated with this method. Similar to GetResult, you can only get the exception once and throws if there is no exception.

When using await or ContinueWith, you do not need to explicitly get the exception. Use this method when you have an exception when it is implicitly created by the compiler and you query the task object directly, as in the following example:

Gets the result of the asynchronous operation.

This method should only be called once IsCompleted is true. Calling it multiple times will throw InvalidOperationException.

Note that GetResult is called implicitly when using await or ContinueWith. You should not call this method explicitly when using one of those mechanisms.

Tries to get the result of the asynchronous operation.

This method may safely be called at any time. It tests whether the operation is both complete (IsCompleted is True) and the result has not already been retrieved with GetResult (HasResult is True).

If the result is available, result is set to the result and this method returns True. This method is equivalent to (though more efficient than) the following:

Converts the task to a ValueTask.

This method converts this OVRTask<TResult> to a ValueTask.

A ValueTask is similar to an OVRTask. Key differences:

• A ValueTask does not support ContinueWith
• A ValueTask does not support WhenAll(System.Collections.Generic.IEnumerable<OVRTask<TResult>>)

The above are only supported on the Task object.

Invoking this method also invalidates this OVRTask<TResult>. It is invalid to continue using an OVRTask<TResult> after calling ToValueTask.

Gets an awaiter that satisfies the await contract.

This allows an OVRTask<T> to be awaited using the await keyword. Typically, you should not call this directly; instead, it is invoked by the compiler, e.g.,

Or, more commonly:

Requires the main thread to complete the await contract - blocking can result in an infinite loop.

Registers a delegate to be invoked on completion of the task.

The delegate will be invoked with the TResult result as parameter.

Do not use in conjunction with any other methods (await or calling GetResult).

Note: If the task throws an exception during execution, there is no way to catch it in when using ContinueWith. Most Meta XR Core SDK calls that return an OVRTask do not throw, but it is possible to return an OVRTask<TResult> from your own async method, which can still throw. For example,

In the above example, the exception generated by DoSomethingAsync is caught in MethodA, but there is no way to catch it in MethodB because it uses ContinueWith rather than await. The exception is still thrown, however.

Registers a delegate that will get called on completion of the task.

The delegate will be invoked with state and the TResult result as parameters. Do not use in conjunction with any other methods (await or calling GetResult).

Note: If the task throws an exception during execution, there is no way to catch it in when using a callback. See ContinueWith(Action<TResult>) for more details.

Disposes of the task.

Invalidate this object but does not cancel the task. In the case where the result will not actually be consumed, it must be called to prevent a memory leak. You can not call GetResult nor use await on a disposed task.