Skip to content

Commit f76ebd3

Browse files
MSDN-WhiteKnightRon Petrusha
authored andcommitted
Add documentation for IAsyncDisposable (#2575)
* Add documentation for IAsyncDisposable Based on source code comments (https://github.com/dotnet/corefx/blob/master/src/Common/src/CoreLib/System/IAsyncDisposable.cs) and Async Streams proposal description (https://github.com/dotnet/csharplang/blob/master/proposals/csharp-8.0/async-streams.md). * Update IAsyncDisposable.xml * Apply suggestions from code review Co-Authored-By: Ron Petrusha <[email protected]> * Fix xref tag
1 parent 2500b44 commit f76ebd3

File tree

1 file changed

+47
-6
lines changed

1 file changed

+47
-6
lines changed

xml/System/IAsyncDisposable.xml

Lines changed: 47 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,34 @@
1515
</AssemblyInfo>
1616
<Interfaces />
1717
<Docs>
18-
<summary>To be added.</summary>
19-
<remarks>To be added.</remarks>
18+
<summary>Provides a mechanism for releasing unmanaged resources asynchronously.</summary>
19+
<remarks>
20+
<format type="text/markdown"><![CDATA[
21+
22+
## Remarks
23+
24+
In .NET, classes that own unmanaged resources usually implement the <xref:System.IDisposable> interface to provide a mechanism for releasing unmanaged resources synchronously. However, in some cases they need to provide an asynchronous mechanism for releasing unmanaged resources in addition to (or instead of) the synchronous one. Providing such a mechanism enables the consumer to perform resource-intensive dispose operations without blocking the main thread of a GUI application for a long time.
25+
26+
The <xref:System.IAsyncDisposable.DisposeAsync%2A?displayProperty=nameWithType> method of this interface returns a <xref:System.Threading.Tasks.ValueTask> that represents the asynchronous dispose operation. Classes that own unmanaged resources implement this method, and the consumer of these classes calls this method on an object when it is no longer needed.
27+
28+
The async methods are used in conjunction with the `async` and `await` keywords in C# and Visual Basic. For more insformation, see [The Task asynchronous programming model in C#](/dotnet/csharp/programming-guide/concepts/async/index) or [Asynchronous Programming with Async and Await (Visual Basic)](/dotnet/visual-basic/programming-guide/concepts/async/).
29+
30+
### Using an object that implements IAsyncDisposable
31+
32+
If your application uses an object that implements `IAsyncDisposable`, you should call the object's <xref:System.IAsyncDisposable.DisposeAsync%2A> implementation when you are finished using it. To make sure resources are released even in case of an exception, call the <xref:System.IAsyncDisposable.DisposeAsync%2A> method inside a `finally` clause of the `try`/`finally` statement. For more information about the `try`/`finally` pattern, see [try-finally](~/docs/csharp/language-reference/keywords/try-finally.md) (C#) or [Try...Catch...Finally Statement](~/docs/visual-basic/language-reference/statements/try-catch-finally-statement.md) (Visual Basic).
33+
34+
### Implementing IAsyncDisposable
35+
36+
You might implement `IAsyncDisposable` in the following situations:
37+
38+
- When developing an asynchronous enumerator that owns unmanaged resources. Asynchronous enumerators are used with the C# 8.0 async streams feature. For more information about async streams, see [Tutorial: Generate and consume async streams using C# 8.0 and .NET Core 3.0](/dotnet/csharp/tutorials/generate-consume-asynchronous-stream).
39+
40+
- When your class owns unmanaged resources and releasing them requires a resource-intensive I/O operation, such as flushing the contents of an intermediate buffer into a file or sending a packet over a network to close a connection.
41+
42+
Use the <xref:System.IAsyncDisposable.DisposeAsync%2A> method to perform whatever cleanup is necessary after using the unmanaged resources, such as freeing, releasing, or resetting the unmanaged resources. For more information about unmanaged resources in .NET, see [Cleaning Up Unmanaged Resources](/dotnet/standard/garbage-collection/unmanaged).
43+
44+
]]></format>
45+
</remarks>
2046
</Docs>
2147
<Members>
2248
<Member MemberName="DisposeAsync">
@@ -40,10 +66,25 @@
4066
</ReturnValue>
4167
<Parameters />
4268
<Docs>
43-
<summary>To be added.</summary>
44-
<returns>To be added.</returns>
45-
<remarks>To be added.</remarks>
69+
<summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources asynchronously.</summary>
70+
<returns>A task that represents the asynchronous dispose operation.</returns>
71+
<remarks>
72+
<format type="text/markdown"><![CDATA[
73+
74+
## Remarks
75+
76+
Use this method to asynchronously close or release unmanaged resources such as files, streams, and handles held by an instance of the class that implements this interface. Using this method instead of <xref:System.IDisposable.Dispose%2A?displayProperty=nameWithType> enables you to perform a resource-intensive dispose operation without blocking the main thread of a GUI application for a long time.
77+
78+
> [!WARNING]
79+
> If you are using a class that implements the <xref:System.IAsyncDisposable> interface, you should call its `DisposeAsync` implementation when you are finished using the class. For more information, see the "Using an object that implements IAsyncDisposable" section in the <xref:System.IAsyncDisposable> topic.
80+
81+
When implementing this method, ensure that all held resources are freed by propagating the call through the containment hierarchy. For example, if an object A allocates an object B, and object B allocates an object C, then A's `DisposeAsync` implementation must call `DisposeAsync` on B, which must in turn call `DisposeAsync` on C. An object must also call the `DisposeAsync` method of its base class if the base class implements <xref:System.IAsyncDisposable>.
82+
83+
If an object's `DisposeAsync` method is called more than once, the object must ignore all calls after the first one and synchronously return a successfully completed <xref:System.Threading.Tasks.ValueTask>. The object must not throw an exception if its `DisposeAsync` method is called multiple times. Instance methods other than `DisposeAsync` can throw an <xref:System.ObjectDisposedException> when resources are already disposed.
84+
85+
]]></format>
86+
</remarks>
4687
</Docs>
4788
</Member>
4889
</Members>
49-
</Type>
90+
</Type>

0 commit comments

Comments
 (0)