blob: 699741cd054420c48915615af10aaf629de060e9 [file] [log] [blame]
Jan Tattermuscha5272b62015-04-30 11:56:46 -07001#region Copyright notice and license
Jan Tattermuscha7fff862015-02-13 11:08:08 -08002
Jan Tattermuschaf77b3d2015-02-13 11:22:21 -08003// Copyright 2015, Google Inc.
Jan Tattermuscha7fff862015-02-13 11:08:08 -08004// All rights reserved.
Craig Tiller190d3602015-02-18 09:23:38 -08005//
Jan Tattermuscha7fff862015-02-13 11:08:08 -08006// Redistribution and use in source and binary forms, with or without
7// modification, are permitted provided that the following conditions are
8// met:
Craig Tiller190d3602015-02-18 09:23:38 -08009//
Jan Tattermuscha7fff862015-02-13 11:08:08 -080010// * Redistributions of source code must retain the above copyright
11// notice, this list of conditions and the following disclaimer.
12// * Redistributions in binary form must reproduce the above
13// copyright notice, this list of conditions and the following disclaimer
14// in the documentation and/or other materials provided with the
15// distribution.
16// * Neither the name of Google Inc. nor the names of its
17// contributors may be used to endorse or promote products derived from
18// this software without specific prior written permission.
Craig Tiller190d3602015-02-18 09:23:38 -080019//
Jan Tattermuscha7fff862015-02-13 11:08:08 -080020// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31
32#endregion
33
Jan Tattermuscha7608b02015-02-03 17:54:38 -080034using System;
Jan Tattermuscha7608b02015-02-03 17:54:38 -080035using System.Collections.Generic;
Jan Tattermuscha5272b62015-04-30 11:56:46 -070036using System.Linq;
37using System.Text;
Jan Tattermusch30868622015-02-19 09:22:33 -080038using System.Threading.Tasks;
Jan Tattermuscha7608b02015-02-03 17:54:38 -080039
Jan Tattermuscha5272b62015-04-30 11:56:46 -070040namespace Grpc.Core
Jan Tattermuscha7608b02015-02-03 17:54:38 -080041{
Jan Tattermuscha5272b62015-04-30 11:56:46 -070042 /// <summary>
43 /// A stream of messages to be read.
44 /// </summary>
45 /// <typeparam name="T"></typeparam>
46 public interface IAsyncStreamReader<T>
Jan Tattermuschbdb1b482015-05-06 14:46:25 -070047 where T : class
Jan Tattermuscha7608b02015-02-03 17:54:38 -080048 {
Jan Tattermuscha5272b62015-04-30 11:56:46 -070049 /// <summary>
Jan Tattermuschbdb1b482015-05-06 14:46:25 -070050 /// Reads a single message. Returns null if the last message was already read.
Jan Tattermuscha5272b62015-04-30 11:56:46 -070051 /// A following read can only be started when the previous one finishes.
52 /// </summary>
53 Task<T> ReadNext();
Jan Tattermuscha7608b02015-02-03 17:54:38 -080054 }
55}