#region Copyright notice and license
// Copyright 2015-2016 gRPC authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#endregion
using System;
using Grpc.Core.Interceptors;
using Grpc.Core.Internal;
using Grpc.Core.Utils;
namespace Grpc.Core
{
///
/// Generic base class for client-side stubs.
///
public abstract class ClientBase : ClientBase
where T : ClientBase
{
///
/// Initializes a new instance of ClientBase class that
/// throws NotImplementedException upon invocation of any RPC.
/// This constructor is only provided to allow creation of test doubles
/// for client classes (e.g. mocking requires a parameterless constructor).
///
protected ClientBase() : base()
{
}
///
/// Initializes a new instance of ClientBase class.
///
/// The configuration.
protected ClientBase(ClientBaseConfiguration configuration) : base(configuration)
{
}
///
/// Initializes a new instance of ClientBase class.
///
/// The channel to use for remote call invocation.
public ClientBase(Channel channel) : base(channel)
{
}
///
/// Initializes a new instance of ClientBase class.
///
/// The CallInvoker for remote call invocation.
public ClientBase(CallInvoker callInvoker) : base(callInvoker)
{
}
///
/// Creates a new client that sets host field for calls explicitly.
/// gRPC supports multiple "hosts" being served by a single server.
/// By default (if a client was not created by calling this method),
/// host null with the meaning "use default host" is used.
///
public T WithHost(string host)
{
var newConfiguration = this.Configuration.WithHost(host);
return NewInstance(newConfiguration);
}
///
/// Creates a new instance of client from given ClientBaseConfiguration.
///
protected abstract T NewInstance(ClientBaseConfiguration configuration);
}
///
/// Base class for client-side stubs.
///
public abstract class ClientBase
{
readonly ClientBaseConfiguration configuration;
readonly CallInvoker callInvoker;
///
/// Initializes a new instance of ClientBase class that
/// throws NotImplementedException upon invocation of any RPC.
/// This constructor is only provided to allow creation of test doubles
/// for client classes (e.g. mocking requires a parameterless constructor).
///
protected ClientBase() : this(new UnimplementedCallInvoker())
{
}
///
/// Initializes a new instance of ClientBase class.
///
/// The configuration.
protected ClientBase(ClientBaseConfiguration configuration)
{
this.configuration = GrpcPreconditions.CheckNotNull(configuration, "configuration");
this.callInvoker = configuration.CreateDecoratedCallInvoker();
}
///
/// Initializes a new instance of ClientBase class.
///
/// The channel to use for remote call invocation.
public ClientBase(Channel channel) : this(new DefaultCallInvoker(channel))
{
}
///
/// Initializes a new instance of ClientBase class.
///
/// The CallInvoker for remote call invocation.
public ClientBase(CallInvoker callInvoker) : this(new ClientBaseConfiguration(callInvoker, null))
{
}
///
/// Gets the call invoker.
///
protected CallInvoker CallInvoker
{
get { return this.callInvoker; }
}
///
/// Gets the configuration.
///
internal ClientBaseConfiguration Configuration
{
get { return this.configuration; }
}
///
/// Represents configuration of ClientBase. The class itself is visible to
/// subclasses, but contents are marked as internal to make the instances opaque.
/// The verbose name of this class was chosen to make name clash in generated code
/// less likely.
///
protected internal class ClientBaseConfiguration
{
private class ClientBaseConfigurationInterceptor : Interceptor
{
readonly Func> interceptor;
///
/// Creates a new instance of ClientBaseConfigurationInterceptor given the specified header and host interceptor function.
///
public ClientBaseConfigurationInterceptor(Func> interceptor)
{
this.interceptor = GrpcPreconditions.CheckNotNull(interceptor, nameof(interceptor));
}
private ClientInterceptorContext GetNewContext(ClientInterceptorContext context)
where TRequest : class
where TResponse : class
{
var newHostAndCallOptions = interceptor(context.Method, context.Host, context.Options);
return new ClientInterceptorContext(context.Method, newHostAndCallOptions.Item1, newHostAndCallOptions.Item2);
}
public override TResponse BlockingUnaryCall(TRequest request, ClientInterceptorContext context, BlockingUnaryCallContinuation continuation)
{
return continuation(request, GetNewContext(context));
}
public override AsyncUnaryCall AsyncUnaryCall(TRequest request, ClientInterceptorContext context, AsyncUnaryCallContinuation continuation)
{
return continuation(request, GetNewContext(context));
}
public override AsyncServerStreamingCall AsyncServerStreamingCall(TRequest request, ClientInterceptorContext context, AsyncServerStreamingCallContinuation continuation)
{
return continuation(request, GetNewContext(context));
}
public override AsyncClientStreamingCall AsyncClientStreamingCall(ClientInterceptorContext context, AsyncClientStreamingCallContinuation continuation)
{
return continuation(GetNewContext(context));
}
public override AsyncDuplexStreamingCall AsyncDuplexStreamingCall(ClientInterceptorContext context, AsyncDuplexStreamingCallContinuation continuation)
{
return continuation(GetNewContext(context));
}
}
readonly CallInvoker undecoratedCallInvoker;
readonly string host;
internal ClientBaseConfiguration(CallInvoker undecoratedCallInvoker, string host)
{
this.undecoratedCallInvoker = GrpcPreconditions.CheckNotNull(undecoratedCallInvoker);
this.host = host;
}
internal CallInvoker CreateDecoratedCallInvoker()
{
return undecoratedCallInvoker.Intercept(new ClientBaseConfigurationInterceptor((method, host, options) => Tuple.Create(this.host, options)));
}
internal ClientBaseConfiguration WithHost(string host)
{
GrpcPreconditions.CheckNotNull(host, nameof(host));
return new ClientBaseConfiguration(this.undecoratedCallInvoker, host);
}
}
}
}