Early Preview
This is currently very much a preview. Please feel free to try things out,
but don't be upset if anything is not yet working. Feedback is welcome over on our
GitHub Dicussions page.
class System.Threading.Tasks.TaskToAsyncResult
Assembly: System.Runtime
Inheritance: object → TaskToAsyncResult
Provides methods for using <see cref="T:System.Threading.Tasks.Task" /> to implement the Asynchronous Programming Model pattern based on "Begin" and "End" methods.
Methods
public static
IAsyncResult
Begin(Task task,
AsyncCallback? callback,
object state)
Creates a new <see cref="T:System.IAsyncResult" /> from the specified <see cref="T:System.Threading.Tasks.Task" /> , optionally invoking <paramref name="callback" /> when the task has completed.
Returns An <see cref="T:System.IAsyncResult" /> to represent the task's asynchronous operation. This instance will also be passed to <paramref name="callback" /> when it's invoked.
task
The <see cref="T:System.Threading.Tasks.Task" /> to be wrapped in an <see cref="T:System.IAsyncResult" /> .
callback
The callback to be invoked upon <paramref name="task" /> 's completion. If <see langword="null" /> , no callback will be invoked.
state
The state to be stored in the <see cref="T:System.IAsyncResult" /> .
public static
void
End(IAsyncResult asyncResult)
Waits for the <see cref="T:System.Threading.Tasks.Task" /> wrapped by the <see cref="T:System.IAsyncResult" /> returned by <see cref="M:System.Threading.Tasks.TaskToAsyncResult.Begin(System.Threading.Tasks.Task,System.AsyncCallback,System.Object)" /> to complete.
asyncResult
The <see cref="T:System.IAsyncResult" /> for which to wait.
public static
TResult
End(IAsyncResult asyncResult)
Waits for the <see cref="T:System.Threading.Tasks.Task`1" /> wrapped by the <see cref="T:System.IAsyncResult" /> returned by <see cref="M:System.Threading.Tasks.TaskToAsyncResult.Begin(System.Threading.Tasks.Task,System.AsyncCallback,System.Object)" /> to complete.
Returns The result of the <see cref="T:System.Threading.Tasks.Task`1" /> wrapped by the <see cref="T:System.IAsyncResult" /> .
asyncResult
The <see cref="T:System.IAsyncResult" /> for which to wait.
public static
Task
Unwrap(IAsyncResult asyncResult)
Extracts the underlying <see cref="T:System.Threading.Tasks.Task" /> from an <see cref="T:System.IAsyncResult" /> created by <see cref="M:System.Threading.Tasks.TaskToAsyncResult.Begin(System.Threading.Tasks.Task,System.AsyncCallback,System.Object)" /> .
Returns The <see cref="T:System.Threading.Tasks.Task" /> wrapped by the <see cref="T:System.IAsyncResult" /> .
asyncResult
The <see cref="T:System.IAsyncResult" /> created by <see cref="M:System.Threading.Tasks.TaskToAsyncResult.Begin(System.Threading.Tasks.Task,System.AsyncCallback,System.Object)" /> .
public static
Task<TResult>
Unwrap(IAsyncResult asyncResult)
Extracts the underlying <see cref="T:System.Threading.Tasks.Task`1" /> from an <see cref="T:System.IAsyncResult" /> created by <see cref="M:System.Threading.Tasks.TaskToAsyncResult.Begin(System.Threading.Tasks.Task,System.AsyncCallback,System.Object)" /> .
Returns The <see cref="T:System.Threading.Tasks.Task`1" /> wrapped by the <see cref="T:System.IAsyncResult" /> .
asyncResult
The <see cref="T:System.IAsyncResult" /> created by <see cref="M:System.Threading.Tasks.TaskToAsyncResult.Begin(System.Threading.Tasks.Task,System.AsyncCallback,System.Object)" /> .
public
bool
Equals(object obj)
Inherited from object
Determines whether the specified object is equal to the current object.
Returns <see langword="true" /> if the specified object is equal to the current object; otherwise, <see langword="false" /> .
obj
The object to compare with the current object.
protected
void
Finalize()
Inherited from object
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
public
int
GetHashCode()
Inherited from object
Serves as the default hash function.
Returns A hash code for the current object.
public
Type
GetType()
Inherited from object
Gets the <see cref="T:System.Type" /> of the current instance.
Returns The exact runtime type of the current instance.
protected
object
MemberwiseClone()
Inherited from object
Creates a shallow copy of the current <see cref="T:System.Object" /> .
Returns A shallow copy of the current <see cref="T:System.Object" /> .
public
string
ToString()
Inherited from object
Returns a string that represents the current object.
Returns A string that represents the current object.