#region Copyright notice and license // Copyright 2015-2016, 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 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 { readonly CallInvoker undecoratedCallInvoker; readonly string host; internal ClientBaseConfiguration(CallInvoker undecoratedCallInvoker, string host) { this.undecoratedCallInvoker = GrpcPreconditions.CheckNotNull(undecoratedCallInvoker); this.host = host; } internal CallInvoker CreateDecoratedCallInvoker() { return new InterceptingCallInvoker(undecoratedCallInvoker, hostInterceptor: (h) => host); } internal ClientBaseConfiguration WithHost(string host) { GrpcPreconditions.CheckNotNull(host, "host"); return new ClientBaseConfiguration(this.undecoratedCallInvoker, host); } } } }