aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/csharp/Grpc.Core/IAsyncStreamReader.cs
diff options
context:
space:
mode:
authorGravatar Mark D. Roth <roth@google.com>2017-12-01 08:56:25 -0800
committerGravatar Mark D. Roth <roth@google.com>2017-12-01 08:56:25 -0800
commite109ddf89f966b1f99290ec15a14ec3859049099 (patch)
treed9505ff4cc7e19c87a740cc7d379c47810b19417 /src/csharp/Grpc.Core/IAsyncStreamReader.cs
parentc5d0df9e44068b82a9980e4f700ffebfbabc9ed2 (diff)
parent44c143c587c219ddae4ec3dbce003c0bd6c6c9e6 (diff)
Merge remote-tracking branch 'upstream/master' into server_connection_timeout
Diffstat (limited to 'src/csharp/Grpc.Core/IAsyncStreamReader.cs')
-rw-r--r--src/csharp/Grpc.Core/IAsyncStreamReader.cs7
1 files changed, 7 insertions, 0 deletions
diff --git a/src/csharp/Grpc.Core/IAsyncStreamReader.cs b/src/csharp/Grpc.Core/IAsyncStreamReader.cs
index 42bfbb87e0..3751d549e3 100644
--- a/src/csharp/Grpc.Core/IAsyncStreamReader.cs
+++ b/src/csharp/Grpc.Core/IAsyncStreamReader.cs
@@ -41,6 +41,13 @@ namespace Grpc.Core
/// (<c>MoveNext</c> will return <c>false</c>) and the <c>CancellationToken</c>
/// associated with the call will be cancelled to signal the failure.
/// </para>
+ /// <para>
+ /// <c>MoveNext()</c> operations can be cancelled via a cancellation token. Cancelling
+ /// an individual read operation has the same effect as cancelling the entire call
+ /// (which will also result in the read operation returning prematurely), but the per-read cancellation
+ /// tokens passed to MoveNext() only result in cancelling the call if the read operation haven't finished
+ /// yet.
+ /// </para>
/// </summary>
/// <typeparam name="T">The message type.</typeparam>
public interface IAsyncStreamReader<T> : IAsyncEnumerator<T>