added concept of ServerCallContext, that is passed to all server-side handlers

pull/1504/head
Jan Tattermusch 10 years ago
parent bdb1b4863b
commit 8ab1f7ed3d
  1. 4
      src/csharp/Grpc.Core.Tests/ClientServerTest.cs
  2. 1
      src/csharp/Grpc.Core/Grpc.Core.csproj
  3. 12
      src/csharp/Grpc.Core/Internal/ServerCallHandler.cs
  4. 56
      src/csharp/Grpc.Core/ServerCallContext.cs
  5. 8
      src/csharp/Grpc.Core/ServerMethods.cs
  6. 8
      src/csharp/Grpc.Examples/MathGrpc.cs
  7. 8
      src/csharp/Grpc.Examples/MathServiceImpl.cs
  8. 12
      src/csharp/Grpc.IntegrationTesting/TestServiceGrpc.cs
  9. 12
      src/csharp/Grpc.IntegrationTesting/TestServiceImpl.cs

@ -220,7 +220,7 @@ namespace Grpc.Core.Tests
} }
} }
private static async Task<string> EchoHandler(string request) private static async Task<string> EchoHandler(ServerCallContext context, string request)
{ {
if (request == "THROW") if (request == "THROW")
{ {
@ -229,7 +229,7 @@ namespace Grpc.Core.Tests
return request; return request;
} }
private static async Task<string> ConcatAndEchoHandler(IAsyncStreamReader<string> requestStream) private static async Task<string> ConcatAndEchoHandler(ServerCallContext context, IAsyncStreamReader<string> requestStream)
{ {
string result = ""; string result = "";
await requestStream.ForEach(async (request) => await requestStream.ForEach(async (request) =>

@ -96,6 +96,7 @@
<Compile Include="Internal\ServerResponseStream.cs" /> <Compile Include="Internal\ServerResponseStream.cs" />
<Compile Include="Internal\AtomicCounter.cs" /> <Compile Include="Internal\AtomicCounter.cs" />
<Compile Include="Internal\DebugStats.cs" /> <Compile Include="Internal\DebugStats.cs" />
<Compile Include="ServerCallContext.cs" />
</ItemGroup> </ItemGroup>
<ItemGroup> <ItemGroup>
<None Include="packages.config" /> <None Include="packages.config" />

@ -74,7 +74,8 @@ namespace Grpc.Core.Internal
var request = await requestStream.ReadNext(); var request = await requestStream.ReadNext();
// TODO(jtattermusch): we need to read the full stream so that native callhandle gets deallocated. // TODO(jtattermusch): we need to read the full stream so that native callhandle gets deallocated.
Preconditions.CheckArgument(await requestStream.ReadNext() == null); Preconditions.CheckArgument(await requestStream.ReadNext() == null);
var result = await handler(request); var context = new ServerCallContext(); // TODO(jtattermusch): initialize the context
var result = await handler(context, request);
await responseStream.Write(result); await responseStream.Write(result);
} }
catch (Exception e) catch (Exception e)
@ -125,7 +126,8 @@ namespace Grpc.Core.Internal
// TODO(jtattermusch): we need to read the full stream so that native callhandle gets deallocated. // TODO(jtattermusch): we need to read the full stream so that native callhandle gets deallocated.
Preconditions.CheckArgument(await requestStream.ReadNext() == null); Preconditions.CheckArgument(await requestStream.ReadNext() == null);
await handler(request, responseStream); var context = new ServerCallContext(); // TODO(jtattermusch): initialize the context
await handler(context, request, responseStream);
} }
catch (Exception e) catch (Exception e)
{ {
@ -168,11 +170,12 @@ namespace Grpc.Core.Internal
var finishedTask = asyncCall.ServerSideCallAsync(); var finishedTask = asyncCall.ServerSideCallAsync();
var requestStream = new ServerRequestStream<TRequest, TResponse>(asyncCall); var requestStream = new ServerRequestStream<TRequest, TResponse>(asyncCall);
var responseStream = new ServerResponseStream<TRequest, TResponse>(asyncCall); var responseStream = new ServerResponseStream<TRequest, TResponse>(asyncCall);
var context = new ServerCallContext(); // TODO(jtattermusch): initialize the context
Status status = Status.DefaultSuccess; Status status = Status.DefaultSuccess;
try try
{ {
var result = await handler(requestStream); var result = await handler(context, requestStream);
try try
{ {
await responseStream.Write(result); await responseStream.Write(result);
@ -223,11 +226,12 @@ namespace Grpc.Core.Internal
var finishedTask = asyncCall.ServerSideCallAsync(); var finishedTask = asyncCall.ServerSideCallAsync();
var requestStream = new ServerRequestStream<TRequest, TResponse>(asyncCall); var requestStream = new ServerRequestStream<TRequest, TResponse>(asyncCall);
var responseStream = new ServerResponseStream<TRequest, TResponse>(asyncCall); var responseStream = new ServerResponseStream<TRequest, TResponse>(asyncCall);
var context = new ServerCallContext(); // TODO(jtattermusch): initialize the context
Status status = Status.DefaultSuccess; Status status = Status.DefaultSuccess;
try try
{ {
await handler(requestStream, responseStream); await handler(context, requestStream, responseStream);
} }
catch (Exception e) catch (Exception e)
{ {

@ -0,0 +1,56 @@
#region Copyright notice and license
// Copyright 2015, Google Inc.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
// * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#endregion
using System;
using System.Runtime.CompilerServices;
using System.Threading.Tasks;
namespace Grpc.Core
{
/// <summary>
/// Context for a server-side call.
/// </summary>
public sealed class ServerCallContext
{
// TODO(jtattermusch): add cancellationToken
// TODO(jtattermusch): add deadline info
// TODO(jtattermusch): expose initial metadata sent by client for reading
// TODO(jtattermusch): expose method to send initial metadata back to client
// TODO(jtattermusch): allow setting status and trailing metadata to send after handler completes.
}
}

@ -42,28 +42,28 @@ namespace Grpc.Core
/// <summary> /// <summary>
/// Server-side handler for unary call. /// Server-side handler for unary call.
/// </summary> /// </summary>
public delegate Task<TResponse> UnaryServerMethod<TRequest, TResponse>(TRequest request) public delegate Task<TResponse> UnaryServerMethod<TRequest, TResponse>(ServerCallContext context, TRequest request)
where TRequest : class where TRequest : class
where TResponse : class; where TResponse : class;
/// <summary> /// <summary>
/// Server-side handler for client streaming call. /// Server-side handler for client streaming call.
/// </summary> /// </summary>
public delegate Task<TResponse> ClientStreamingServerMethod<TRequest, TResponse>(IAsyncStreamReader<TRequest> requestStream) public delegate Task<TResponse> ClientStreamingServerMethod<TRequest, TResponse>(ServerCallContext context, IAsyncStreamReader<TRequest> requestStream)
where TRequest : class where TRequest : class
where TResponse : class; where TResponse : class;
/// <summary> /// <summary>
/// Server-side handler for server streaming call. /// Server-side handler for server streaming call.
/// </summary> /// </summary>
public delegate Task ServerStreamingServerMethod<TRequest, TResponse>(TRequest request, IServerStreamWriter<TResponse> responseStream) public delegate Task ServerStreamingServerMethod<TRequest, TResponse>(ServerCallContext context, TRequest request, IServerStreamWriter<TResponse> responseStream)
where TRequest : class where TRequest : class
where TResponse : class; where TResponse : class;
/// <summary> /// <summary>
/// Server-side handler for bidi streaming call. /// Server-side handler for bidi streaming call.
/// </summary> /// </summary>
public delegate Task DuplexStreamingServerMethod<TRequest, TResponse>(IAsyncStreamReader<TRequest> requestStream, IServerStreamWriter<TResponse> responseStream) public delegate Task DuplexStreamingServerMethod<TRequest, TResponse>(ServerCallContext context, IAsyncStreamReader<TRequest> requestStream, IServerStreamWriter<TResponse> responseStream)
where TRequest : class where TRequest : class
where TResponse : class; where TResponse : class;
} }

@ -133,13 +133,13 @@ namespace math
// server-side interface // server-side interface
public interface IMathService public interface IMathService
{ {
Task<DivReply> Div(DivArgs request); Task<DivReply> Div(ServerCallContext context, DivArgs request);
Task Fib(FibArgs request, IServerStreamWriter<Num> responseStream); Task Fib(ServerCallContext context, FibArgs request, IServerStreamWriter<Num> responseStream);
Task<Num> Sum(IAsyncStreamReader<Num> requestStream); Task<Num> Sum(ServerCallContext context, IAsyncStreamReader<Num> requestStream);
Task DivMany(IAsyncStreamReader<DivArgs> requestStream, IServerStreamWriter<DivReply> responseStream); Task DivMany(ServerCallContext context, IAsyncStreamReader<DivArgs> requestStream, IServerStreamWriter<DivReply> responseStream);
} }
public static ServerServiceDefinition BindService(IMathService serviceImpl) public static ServerServiceDefinition BindService(IMathService serviceImpl)

@ -46,12 +46,12 @@ namespace math
/// </summary> /// </summary>
public class MathServiceImpl : MathGrpc.IMathService public class MathServiceImpl : MathGrpc.IMathService
{ {
public Task<DivReply> Div(DivArgs request) public Task<DivReply> Div(ServerCallContext context, DivArgs request)
{ {
return Task.FromResult(DivInternal(request)); return Task.FromResult(DivInternal(request));
} }
public async Task Fib(FibArgs request, IServerStreamWriter<Num> responseStream) public async Task Fib(ServerCallContext context, FibArgs request, IServerStreamWriter<Num> responseStream)
{ {
if (request.Limit <= 0) if (request.Limit <= 0)
{ {
@ -68,7 +68,7 @@ namespace math
} }
} }
public async Task<Num> Sum(IAsyncStreamReader<Num> requestStream) public async Task<Num> Sum(ServerCallContext context, IAsyncStreamReader<Num> requestStream)
{ {
long sum = 0; long sum = 0;
await requestStream.ForEach(async num => await requestStream.ForEach(async num =>
@ -78,7 +78,7 @@ namespace math
return Num.CreateBuilder().SetNum_(sum).Build(); return Num.CreateBuilder().SetNum_(sum).Build();
} }
public async Task DivMany(IAsyncStreamReader<DivArgs> requestStream, IServerStreamWriter<DivReply> responseStream) public async Task DivMany(ServerCallContext context, IAsyncStreamReader<DivArgs> requestStream, IServerStreamWriter<DivReply> responseStream)
{ {
await requestStream.ForEach(async divArgs => await requestStream.ForEach(async divArgs =>
{ {

@ -171,17 +171,17 @@ namespace grpc.testing
// server-side interface // server-side interface
public interface ITestService public interface ITestService
{ {
Task<Empty> EmptyCall(Empty request); Task<Empty> EmptyCall(ServerCallContext context, Empty request);
Task<SimpleResponse> UnaryCall(SimpleRequest request); Task<SimpleResponse> UnaryCall(ServerCallContext context, SimpleRequest request);
Task StreamingOutputCall(StreamingOutputCallRequest request, IServerStreamWriter<StreamingOutputCallResponse> responseStream); Task StreamingOutputCall(ServerCallContext context, StreamingOutputCallRequest request, IServerStreamWriter<StreamingOutputCallResponse> responseStream);
Task<StreamingInputCallResponse> StreamingInputCall(IAsyncStreamReader<StreamingInputCallRequest> requestStream); Task<StreamingInputCallResponse> StreamingInputCall(ServerCallContext context, IAsyncStreamReader<StreamingInputCallRequest> requestStream);
Task FullDuplexCall(IAsyncStreamReader<StreamingOutputCallRequest> requestStream, IServerStreamWriter<StreamingOutputCallResponse> responseStream); Task FullDuplexCall(ServerCallContext context, IAsyncStreamReader<StreamingOutputCallRequest> requestStream, IServerStreamWriter<StreamingOutputCallResponse> responseStream);
Task HalfDuplexCall(IAsyncStreamReader<StreamingOutputCallRequest> requestStream, IServerStreamWriter<StreamingOutputCallResponse> responseStream); Task HalfDuplexCall(ServerCallContext context, IAsyncStreamReader<StreamingOutputCallRequest> requestStream, IServerStreamWriter<StreamingOutputCallResponse> responseStream);
} }
public static ServerServiceDefinition BindService(ITestService serviceImpl) public static ServerServiceDefinition BindService(ITestService serviceImpl)

@ -46,19 +46,19 @@ namespace grpc.testing
/// </summary> /// </summary>
public class TestServiceImpl : TestServiceGrpc.ITestService public class TestServiceImpl : TestServiceGrpc.ITestService
{ {
public Task<Empty> EmptyCall(Empty request) public Task<Empty> EmptyCall(ServerCallContext context, Empty request)
{ {
return Task.FromResult(Empty.DefaultInstance); return Task.FromResult(Empty.DefaultInstance);
} }
public Task<SimpleResponse> UnaryCall(SimpleRequest request) public Task<SimpleResponse> UnaryCall(ServerCallContext context, SimpleRequest request)
{ {
var response = SimpleResponse.CreateBuilder() var response = SimpleResponse.CreateBuilder()
.SetPayload(CreateZerosPayload(request.ResponseSize)).Build(); .SetPayload(CreateZerosPayload(request.ResponseSize)).Build();
return Task.FromResult(response); return Task.FromResult(response);
} }
public async Task StreamingOutputCall(StreamingOutputCallRequest request, IServerStreamWriter<StreamingOutputCallResponse> responseStream) public async Task StreamingOutputCall(ServerCallContext context, StreamingOutputCallRequest request, IServerStreamWriter<StreamingOutputCallResponse> responseStream)
{ {
foreach (var responseParam in request.ResponseParametersList) foreach (var responseParam in request.ResponseParametersList)
{ {
@ -68,7 +68,7 @@ namespace grpc.testing
} }
} }
public async Task<StreamingInputCallResponse> StreamingInputCall(IAsyncStreamReader<StreamingInputCallRequest> requestStream) public async Task<StreamingInputCallResponse> StreamingInputCall(ServerCallContext context, IAsyncStreamReader<StreamingInputCallRequest> requestStream)
{ {
int sum = 0; int sum = 0;
await requestStream.ForEach(async request => await requestStream.ForEach(async request =>
@ -78,7 +78,7 @@ namespace grpc.testing
return StreamingInputCallResponse.CreateBuilder().SetAggregatedPayloadSize(sum).Build(); return StreamingInputCallResponse.CreateBuilder().SetAggregatedPayloadSize(sum).Build();
} }
public async Task FullDuplexCall(IAsyncStreamReader<StreamingOutputCallRequest> requestStream, IServerStreamWriter<StreamingOutputCallResponse> responseStream) public async Task FullDuplexCall(ServerCallContext context, IAsyncStreamReader<StreamingOutputCallRequest> requestStream, IServerStreamWriter<StreamingOutputCallResponse> responseStream)
{ {
await requestStream.ForEach(async request => await requestStream.ForEach(async request =>
{ {
@ -91,7 +91,7 @@ namespace grpc.testing
}); });
} }
public async Task HalfDuplexCall(IAsyncStreamReader<StreamingOutputCallRequest> requestStream, IServerStreamWriter<StreamingOutputCallResponse> responseStream) public async Task HalfDuplexCall(ServerCallContext context, IAsyncStreamReader<StreamingOutputCallRequest> requestStream, IServerStreamWriter<StreamingOutputCallResponse> responseStream)
{ {
throw new NotImplementedException(); throw new NotImplementedException();
} }

Loading…
Cancel
Save