1 #region Copyright notice and license 2 3 // Copyright 2015 gRPC authors. 4 // 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 8 // 9 // http://www.apache.org/licenses/LICENSE-2.0 10 // 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. 16 17 #endregion 18 19 using System; 20 using System.Collections.Generic; 21 using System.Linq; 22 using System.Text; 23 using System.Threading.Tasks; 24 25 namespace Grpc.Core 26 { 27 /// <summary> 28 /// A stream of messages to be read. 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> 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 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. 50 /// </para> 51 /// </summary> 52 /// <typeparam name="T">The message type.</typeparam> 53 public interface IAsyncStreamReader<T> : IAsyncEnumerator<T> 54 { 55 } 56 } 57