#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.Collections; using System.Collections.Generic; using System.Diagnostics; using System.Runtime.InteropServices; using System.Threading.Tasks; using Grpc.Core.Internal; using Grpc.Core.Logging; using Grpc.Core.Utils; namespace Grpc.Core { /// /// A gRPC server. /// public class Server { static readonly ILogger Logger = GrpcEnvironment.Logger.ForType(); readonly ServiceDefinitionCollection serviceDefinitions; readonly ServerPortCollection ports; readonly GrpcEnvironment environment; readonly List options; readonly ServerSafeHandle handle; readonly object myLock = new object(); readonly List serviceDefinitionsList = new List(); readonly List serverPortList = new List(); readonly Dictionary callHandlers = new Dictionary(); readonly TaskCompletionSource shutdownTcs = new TaskCompletionSource(); bool startRequested; bool shutdownRequested; /// /// Create a new server. /// /// Channel options. public Server(IEnumerable options = null) { this.serviceDefinitions = new ServiceDefinitionCollection(this); this.ports = new ServerPortCollection(this); this.environment = GrpcEnvironment.GetInstance(); this.options = options != null ? new List(options) : new List(); using (var channelArgs = ChannelOptions.CreateChannelArgs(this.options)) { this.handle = ServerSafeHandle.NewServer(environment.CompletionQueue, channelArgs); } } /// /// Services that will be exported by the server once started. Register a service with this /// server by adding its definition to this collection. /// public ServiceDefinitionCollection Services { get { return serviceDefinitions; } } /// /// Ports on which the server will listen once started. Register a port with this /// server by adding its definition to this collection. /// public ServerPortCollection Ports { get { return ports; } } /// /// Starts the server. /// public void Start() { lock (myLock) { Preconditions.CheckState(!startRequested); startRequested = true; handle.Start(); AllowOneRpc(); } } /// /// Requests server shutdown and when there are no more calls being serviced, /// cleans up used resources. The returned task finishes when shutdown procedure /// is complete. /// public async Task ShutdownAsync() { lock (myLock) { Preconditions.CheckState(startRequested); Preconditions.CheckState(!shutdownRequested); shutdownRequested = true; } handle.ShutdownAndNotify(HandleServerShutdown, environment); await shutdownTcs.Task; handle.Dispose(); } /// /// To allow awaiting termination of the server. /// public Task ShutdownTask { get { return shutdownTcs.Task; } } /// /// Requests server shutdown while cancelling all the in-progress calls. /// The returned task finishes when shutdown procedure is complete. /// public async Task KillAsync() { lock (myLock) { Preconditions.CheckState(startRequested); Preconditions.CheckState(!shutdownRequested); shutdownRequested = true; } handle.ShutdownAndNotify(HandleServerShutdown, environment); handle.CancelAllCalls(); await shutdownTcs.Task; handle.Dispose(); } /// /// Adds a service definition. /// private void AddServiceDefinitionInternal(ServerServiceDefinition serviceDefinition) { lock (myLock) { Preconditions.CheckState(!startRequested); foreach (var entry in serviceDefinition.CallHandlers) { callHandlers.Add(entry.Key, entry.Value); } serviceDefinitionsList.Add(serviceDefinition); } } /// /// Adds a listening port. /// private int AddPortInternal(ServerPort serverPort) { lock (myLock) { Preconditions.CheckNotNull(serverPort.Credentials); Preconditions.CheckState(!startRequested); var address = string.Format("{0}:{1}", serverPort.Host, serverPort.Port); int boundPort; using (var nativeCredentials = serverPort.Credentials.ToNativeCredentials()) { if (nativeCredentials != null) { boundPort = handle.AddSecurePort(address, nativeCredentials); } else { boundPort = handle.AddInsecurePort(address); } } var newServerPort = new ServerPort(serverPort, boundPort); this.serverPortList.Add(newServerPort); return boundPort; } } /// /// Allows one new RPC call to be received by server. /// private void AllowOneRpc() { lock (myLock) { if (!shutdownRequested) { handle.RequestCall(HandleNewServerRpc, environment); } } } /// /// Selects corresponding handler for given call and handles the call. /// private async Task HandleCallAsync(ServerRpcNew newRpc) { try { IServerCallHandler callHandler; if (!callHandlers.TryGetValue(newRpc.Method, out callHandler)) { callHandler = NoSuchMethodCallHandler.Instance; } await callHandler.HandleCall(newRpc, environment); } catch (Exception e) { Logger.Warning(e, "Exception while handling RPC."); } } /// /// Handles the native callback. /// private void HandleNewServerRpc(bool success, BatchContextSafeHandle ctx) { if (success) { ServerRpcNew newRpc = ctx.GetServerRpcNew(); // after server shutdown, the callback returns with null call if (!newRpc.Call.IsInvalid) { Task.Run(async () => await HandleCallAsync(newRpc)); } } AllowOneRpc(); } /// /// Handles native callback. /// private void HandleServerShutdown(bool success, BatchContextSafeHandle ctx) { shutdownTcs.SetResult(null); } /// /// Collection of service definitions. /// public class ServiceDefinitionCollection : IEnumerable { readonly Server server; internal ServiceDefinitionCollection(Server server) { this.server = server; } /// /// Adds a service definition to the server. This is how you register /// handlers for a service with the server. Only call this before Start(). /// public void Add(ServerServiceDefinition serviceDefinition) { server.AddServiceDefinitionInternal(serviceDefinition); } public IEnumerator GetEnumerator() { return server.serviceDefinitionsList.GetEnumerator(); } IEnumerator IEnumerable.GetEnumerator() { return server.serviceDefinitionsList.GetEnumerator(); } } /// /// Collection of server ports. /// public class ServerPortCollection : IEnumerable { readonly Server server; internal ServerPortCollection(Server server) { this.server = server; } /// /// Adds a new port on which server should listen. /// Only call this before Start(). /// The port on which server will be listening. /// public int Add(ServerPort serverPort) { return server.AddPortInternal(serverPort); } /// /// Adds a new port on which server should listen. /// The port on which server will be listening. /// /// the host /// the port. If zero, an unused port is chosen automatically. /// credentials to use to secure this port. public int Add(string host, int port, ServerCredentials credentials) { return Add(new ServerPort(host, port, credentials)); } public IEnumerator GetEnumerator() { return server.serverPortList.GetEnumerator(); } IEnumerator IEnumerable.GetEnumerator() { return server.serverPortList.GetEnumerator(); } } } }