Jan Tattermusch | a5272b6 | 2015-04-30 11:56:46 -0700 | [diff] [blame] | 1 | #region Copyright notice and license |
Jan Tattermusch | a7fff86 | 2015-02-13 11:08:08 -0800 | [diff] [blame] | 2 | |
Jan Tattermusch | 7897ae9 | 2017-06-07 22:57:36 +0200 | [diff] [blame] | 3 | // Copyright 2015 gRPC authors. |
Craig Tiller | 190d360 | 2015-02-18 09:23:38 -0800 | [diff] [blame] | 4 | // |
Jan Tattermusch | 7897ae9 | 2017-06-07 22:57:36 +0200 | [diff] [blame] | 5 | // Licensed under the Apache License, Version 2.0 (the "License"); |
| 6 | // you may not use this file except in compliance with the License. |
| 7 | // You may obtain a copy of the License at |
Craig Tiller | 190d360 | 2015-02-18 09:23:38 -0800 | [diff] [blame] | 8 | // |
Jan Tattermusch | 7897ae9 | 2017-06-07 22:57:36 +0200 | [diff] [blame] | 9 | // http://www.apache.org/licenses/LICENSE-2.0 |
Craig Tiller | 190d360 | 2015-02-18 09:23:38 -0800 | [diff] [blame] | 10 | // |
Jan Tattermusch | 7897ae9 | 2017-06-07 22:57:36 +0200 | [diff] [blame] | 11 | // Unless required by applicable law or agreed to in writing, software |
| 12 | // distributed under the License is distributed on an "AS IS" BASIS, |
| 13 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 14 | // See the License for the specific language governing permissions and |
| 15 | // limitations under the License. |
Jan Tattermusch | a7fff86 | 2015-02-13 11:08:08 -0800 | [diff] [blame] | 16 | |
| 17 | #endregion |
| 18 | |
Jan Tattermusch | a7608b0 | 2015-02-03 17:54:38 -0800 | [diff] [blame] | 19 | using System; |
Jan Tattermusch | a7608b0 | 2015-02-03 17:54:38 -0800 | [diff] [blame] | 20 | using System.Collections.Generic; |
Jan Tattermusch | a5272b6 | 2015-04-30 11:56:46 -0700 | [diff] [blame] | 21 | using System.Linq; |
| 22 | using System.Text; |
Jan Tattermusch | 3086862 | 2015-02-19 09:22:33 -0800 | [diff] [blame] | 23 | using System.Threading.Tasks; |
Jan Tattermusch | a7608b0 | 2015-02-03 17:54:38 -0800 | [diff] [blame] | 24 | |
Jan Tattermusch | a5272b6 | 2015-04-30 11:56:46 -0700 | [diff] [blame] | 25 | namespace Grpc.Core |
Jan Tattermusch | a7608b0 | 2015-02-03 17:54:38 -0800 | [diff] [blame] | 26 | { |
Jan Tattermusch | a5272b6 | 2015-04-30 11:56:46 -0700 | [diff] [blame] | 27 | /// <summary> |
| 28 | /// A stream of messages to be read. |
Jan Tattermusch | 2eb09ee | 2016-06-14 17:50:20 -0700 | [diff] [blame] | 29 | /// Messages can be awaited <c>await reader.MoveNext()</c>, that returns <c>true</c> |
| 30 | /// if there is a message available and <c>false</c> if there are no more messages |
| 31 | /// (i.e. the stream has been closed). |
| 32 | /// <para> |
| 33 | /// On the client side, the last invocation of <c>MoveNext()</c> either returns <c>false</c> |
| 34 | /// if the call has finished successfully or throws <c>RpcException</c> if call finished |
| 35 | /// with an error. Once the call finishes, subsequent invocations of <c>MoveNext()</c> will |
| 36 | /// continue yielding the same result (returning <c>false</c> or throwing an exception). |
| 37 | /// </para> |
| 38 | /// <para> |
| 39 | /// On the server side, <c>MoveNext()</c> does not throw exceptions. |
| 40 | /// In case of a failure, the request stream will appear to be finished |
| 41 | /// (<c>MoveNext</c> will return <c>false</c>) and the <c>CancellationToken</c> |
| 42 | /// associated with the call will be cancelled to signal the failure. |
| 43 | /// </para> |
Jan Tattermusch | bb872c0 | 2017-10-04 16:59:49 +0200 | [diff] [blame] | 44 | /// <para> |
| 45 | /// <c>MoveNext()</c> operations can be cancelled via a cancellation token. Cancelling |
| 46 | /// an individual read operation has the same effect as cancelling the entire call |
Jan Tattermusch | ee35223 | 2017-10-05 16:11:34 +0200 | [diff] [blame] | 47 | /// (which will also result in the read operation returning prematurely), but the per-read cancellation |
| 48 | /// tokens passed to MoveNext() only result in cancelling the call if the read operation haven't finished |
| 49 | /// yet. |
Jan Tattermusch | bb872c0 | 2017-10-04 16:59:49 +0200 | [diff] [blame] | 50 | /// </para> |
Jan Tattermusch | a5272b6 | 2015-04-30 11:56:46 -0700 | [diff] [blame] | 51 | /// </summary> |
Jan Tattermusch | 12855fc | 2015-08-24 16:43:23 -0700 | [diff] [blame] | 52 | /// <typeparam name="T">The message type.</typeparam> |
Jan Tattermusch | 4dd2509 | 2015-08-09 01:01:33 -0700 | [diff] [blame] | 53 | public interface IAsyncStreamReader<T> : IAsyncEnumerator<T> |
Jan Tattermusch | a7608b0 | 2015-02-03 17:54:38 -0800 | [diff] [blame] | 54 | { |
Jan Tattermusch | a7608b0 | 2015-02-03 17:54:38 -0800 | [diff] [blame] | 55 | } |
| 56 | } |