Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 1 | /* |
| 2 | * |
Craig Tiller | 6169d5f | 2016-03-31 07:46:18 -0700 | [diff] [blame] | 3 | * Copyright 2015, Google Inc. |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 4 | * All rights reserved. |
| 5 | * |
| 6 | * Redistribution and use in source and binary forms, with or without |
| 7 | * modification, are permitted provided that the following conditions are |
| 8 | * met: |
| 9 | * |
| 10 | * * 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. |
| 19 | * |
| 20 | * 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 | */ |
| 33 | |
Nicolas "Pixel" Noble | 1ff52d5 | 2015-03-01 05:24:36 +0100 | [diff] [blame] | 34 | #ifndef GRPCXX_SERVER_H |
| 35 | #define GRPCXX_SERVER_H |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 36 | |
Vijay Pai | 320ed13 | 2016-11-01 17:16:55 -0700 | [diff] [blame] | 37 | #include <condition_variable> |
Craig Tiller | cbd0485 | 2015-02-10 17:39:54 -0800 | [diff] [blame] | 38 | #include <list> |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 39 | #include <memory> |
Vijay Pai | 320ed13 | 2016-11-01 17:16:55 -0700 | [diff] [blame] | 40 | #include <mutex> |
Yuchen Zeng | a42ec21 | 2016-04-29 13:03:06 -0700 | [diff] [blame] | 41 | #include <vector> |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 42 | |
| 43 | #include <grpc++/completion_queue.h> |
Craig Tiller | bb5227f | 2015-02-11 13:34:48 -0800 | [diff] [blame] | 44 | #include <grpc++/impl/call.h> |
David Garcia Quintas | e1300de | 2016-01-27 18:41:26 -0800 | [diff] [blame] | 45 | #include <grpc++/impl/codegen/grpc_library.h> |
| 46 | #include <grpc++/impl/codegen/server_interface.h> |
Craig Tiller | 15f383c | 2016-01-07 12:45:32 -0800 | [diff] [blame] | 47 | #include <grpc++/impl/rpc_service_method.h> |
Julien Boeuf | 0d47192 | 2015-08-30 22:18:50 -0700 | [diff] [blame] | 48 | #include <grpc++/security/server_credentials.h> |
yang-g | a23f17b | 2015-11-25 10:21:05 -0800 | [diff] [blame] | 49 | #include <grpc++/support/channel_arguments.h> |
yang-g | 9e2f90c | 2015-08-21 15:35:03 -0700 | [diff] [blame] | 50 | #include <grpc++/support/config.h> |
| 51 | #include <grpc++/support/status.h> |
yang-g | a23f17b | 2015-11-25 10:21:05 -0800 | [diff] [blame] | 52 | #include <grpc/compression.h> |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 53 | |
| 54 | struct grpc_server; |
| 55 | |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 56 | namespace grpc { |
Craig Tiller | 50a7a68 | 2015-06-04 12:53:40 -0700 | [diff] [blame] | 57 | |
Yang Gao | 4999649 | 2015-03-12 16:40:19 -0700 | [diff] [blame] | 58 | class AsyncGenericService; |
yang-g | c9d2954 | 2016-12-06 14:20:17 -0800 | [diff] [blame] | 59 | class HealthCheckServiceInterface; |
Craig Tiller | 7221d99 | 2015-11-24 06:59:33 -0800 | [diff] [blame] | 60 | class ServerContext; |
Yuchen Zeng | a42ec21 | 2016-04-29 13:03:06 -0700 | [diff] [blame] | 61 | class ServerInitializer; |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 62 | |
Craig Tiller | d6599a3 | 2015-09-03 09:37:02 -0700 | [diff] [blame] | 63 | /// Models a gRPC server. |
| 64 | /// |
| 65 | /// Servers are configured and started via \a grpc::ServerBuilder. |
Vijay Pai | c0b2acb | 2016-11-01 16:31:56 -0700 | [diff] [blame] | 66 | class Server final : public ServerInterface, private GrpcLibraryCodegen { |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 67 | public: |
| 68 | ~Server(); |
| 69 | |
Craig Tiller | d6599a3 | 2015-09-03 09:37:02 -0700 | [diff] [blame] | 70 | /// Block waiting for all work to complete. |
| 71 | /// |
| 72 | /// \warning The server must be either shutting down or some other thread must |
| 73 | /// call \a Shutdown for this function to ever return. |
Vijay Pai | c0b2acb | 2016-11-01 16:31:56 -0700 | [diff] [blame] | 74 | void Wait() override; |
Craig Tiller | 6e57b9e | 2015-02-24 15:46:22 -0800 | [diff] [blame] | 75 | |
Craig Tiller | 7221d99 | 2015-11-24 06:59:33 -0800 | [diff] [blame] | 76 | /// Global Callbacks |
| 77 | /// |
| 78 | /// Can be set exactly once per application to install hooks whenever |
| 79 | /// a server event occurs |
| 80 | class GlobalCallbacks { |
| 81 | public: |
Craig Tiller | 8352b9e | 2015-12-02 11:43:40 -0800 | [diff] [blame] | 82 | virtual ~GlobalCallbacks() {} |
yang-g | eb62c94 | 2016-02-17 15:37:25 -0800 | [diff] [blame] | 83 | /// Called before server is created. |
| 84 | virtual void UpdateArguments(ChannelArguments* args) {} |
Craig Tiller | 8352b9e | 2015-12-02 11:43:40 -0800 | [diff] [blame] | 85 | /// Called before application callback for each synchronous server request |
Craig Tiller | 7221d99 | 2015-11-24 06:59:33 -0800 | [diff] [blame] | 86 | virtual void PreSynchronousRequest(ServerContext* context) = 0; |
Craig Tiller | 8352b9e | 2015-12-02 11:43:40 -0800 | [diff] [blame] | 87 | /// Called after application callback for each synchronous server request |
Craig Tiller | 7221d99 | 2015-11-24 06:59:33 -0800 | [diff] [blame] | 88 | virtual void PostSynchronousRequest(ServerContext* context) = 0; |
yang-g | f2fe4f7 | 2017-02-07 12:47:22 -0800 | [diff] [blame] | 89 | /// Called before server is started. |
| 90 | virtual void PreServerStart(Server* server) {} |
yang-g | d510fcf | 2017-03-31 11:00:02 -0700 | [diff] [blame] | 91 | /// Called after a server port is added. |
| 92 | virtual void AddPort(Server* server, int port) {} |
Craig Tiller | 7221d99 | 2015-11-24 06:59:33 -0800 | [diff] [blame] | 93 | }; |
Craig Tiller | 8352b9e | 2015-12-02 11:43:40 -0800 | [diff] [blame] | 94 | /// Set the global callback object. Can only be called once. Does not take |
| 95 | /// ownership of callbacks, and expects the pointed to object to be alive |
| 96 | /// until all server objects in the process have been destroyed. |
Craig Tiller | 7221d99 | 2015-11-24 06:59:33 -0800 | [diff] [blame] | 97 | static void SetGlobalCallbacks(GlobalCallbacks* callbacks); |
| 98 | |
Adam Michalik | b97e2d1 | 2016-06-02 12:12:55 -0700 | [diff] [blame] | 99 | // Returns a \em raw pointer to the underlying grpc_server instance. |
| 100 | grpc_server* c_server(); |
| 101 | |
yang-g | 8d668d8 | 2016-12-01 15:09:28 -0800 | [diff] [blame] | 102 | /// Returns the health check service. |
| 103 | HealthCheckServiceInterface* GetHealthCheckService() const { |
yang-g | c9d2954 | 2016-12-06 14:20:17 -0800 | [diff] [blame] | 104 | return health_check_service_.get(); |
yang-g | 8d668d8 | 2016-12-01 15:09:28 -0800 | [diff] [blame] | 105 | } |
| 106 | |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 107 | private: |
Yang Gao | 4999649 | 2015-03-12 16:40:19 -0700 | [diff] [blame] | 108 | friend class AsyncGenericService; |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 109 | friend class ServerBuilder; |
Yuchen Zeng | a42ec21 | 2016-04-29 13:03:06 -0700 | [diff] [blame] | 110 | friend class ServerInitializer; |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 111 | |
Craig Tiller | 1c9a2a9 | 2015-02-12 14:10:25 -0800 | [diff] [blame] | 112 | class SyncRequest; |
| 113 | class AsyncRequest; |
Craig Tiller | bce999f | 2015-05-27 09:55:51 -0700 | [diff] [blame] | 114 | class ShutdownRequest; |
Craig Tiller | cbd0485 | 2015-02-10 17:39:54 -0800 | [diff] [blame] | 115 | |
Sree Kuchibhotla | 8f7739b | 2016-10-13 15:12:55 -0700 | [diff] [blame] | 116 | /// SyncRequestThreadManager is an implementation of ThreadManager. This class |
| 117 | /// is responsible for polling for incoming RPCs and calling the RPC handlers. |
Sree Kuchibhotla | aabada9 | 2016-08-24 10:01:13 -0700 | [diff] [blame] | 118 | /// This is only used in case of a Sync server (i.e a server exposing a sync |
| 119 | /// interface) |
Sree Kuchibhotla | 8f7739b | 2016-10-13 15:12:55 -0700 | [diff] [blame] | 120 | class SyncRequestThreadManager; |
Sree Kuchibhotla | aabada9 | 2016-08-24 10:01:13 -0700 | [diff] [blame] | 121 | |
David Garcia Quintas | 44f3249 | 2016-01-14 18:00:04 -0800 | [diff] [blame] | 122 | class UnimplementedAsyncRequestContext; |
| 123 | class UnimplementedAsyncRequest; |
| 124 | class UnimplementedAsyncResponse; |
| 125 | |
Craig Tiller | d6599a3 | 2015-09-03 09:37:02 -0700 | [diff] [blame] | 126 | /// Server constructors. To be used by \a ServerBuilder only. |
| 127 | /// |
Craig Tiller | d6599a3 | 2015-09-03 09:37:02 -0700 | [diff] [blame] | 128 | /// \param max_message_size Maximum message length that the channel can |
| 129 | /// receive. |
Sree Kuchibhotla | aabada9 | 2016-08-24 10:01:13 -0700 | [diff] [blame] | 130 | /// |
| 131 | /// \param args The channel args |
| 132 | /// |
Sree Kuchibhotla | e4eb51f | 2016-10-18 11:51:28 -0700 | [diff] [blame] | 133 | /// \param sync_server_cqs The completion queues to use if the server is a |
| 134 | /// synchronous server (or a hybrid server). The server polls for new RPCs on |
| 135 | /// these queues |
| 136 | /// |
Sree Kuchibhotla | aabada9 | 2016-08-24 10:01:13 -0700 | [diff] [blame] | 137 | /// \param min_pollers The minimum number of polling threads per server |
| 138 | /// completion queue (in param sync_server_cqs) to use for listening to |
| 139 | /// incoming requests (used only in case of sync server) |
| 140 | /// |
| 141 | /// \param max_pollers The maximum number of polling threads per server |
| 142 | /// completion queue (in param sync_server_cqs) to use for listening to |
| 143 | /// incoming requests (used only in case of sync server) |
Sree Kuchibhotla | 892dbf4 | 2016-09-27 19:42:27 -0700 | [diff] [blame] | 144 | /// |
| 145 | /// \param sync_cq_timeout_msec The timeout to use when calling AsyncNext() on |
| 146 | /// server completion queues passed via sync_server_cqs param. |
Sree Kuchibhotla | e4eb51f | 2016-10-18 11:51:28 -0700 | [diff] [blame] | 147 | Server(int max_message_size, ChannelArguments* args, |
| 148 | std::shared_ptr<std::vector<std::unique_ptr<ServerCompletionQueue>>> |
Sree Kuchibhotla | 4028d2c | 2016-09-21 10:45:33 -0700 | [diff] [blame] | 149 | sync_server_cqs, |
Sree Kuchibhotla | e4eb51f | 2016-10-18 11:51:28 -0700 | [diff] [blame] | 150 | int min_pollers, int max_pollers, int sync_cq_timeout_msec); |
Craig Tiller | d6599a3 | 2015-09-03 09:37:02 -0700 | [diff] [blame] | 151 | |
| 152 | /// Register a service. This call does not take ownership of the service. |
| 153 | /// The service must exist for the lifetime of the Server instance. |
Vijay Pai | 713c7b8 | 2016-11-01 16:33:18 -0700 | [diff] [blame] | 154 | bool RegisterService(const grpc::string* host, Service* service) override; |
Craig Tiller | d6599a3 | 2015-09-03 09:37:02 -0700 | [diff] [blame] | 155 | |
| 156 | /// Register a generic service. This call does not take ownership of the |
| 157 | /// service. The service must exist for the lifetime of the Server instance. |
Vijay Pai | c0b2acb | 2016-11-01 16:31:56 -0700 | [diff] [blame] | 158 | void RegisterAsyncGenericService(AsyncGenericService* service) override; |
Craig Tiller | d6599a3 | 2015-09-03 09:37:02 -0700 | [diff] [blame] | 159 | |
| 160 | /// Tries to bind \a server to the given \a addr. |
| 161 | /// |
| 162 | /// It can be invoked multiple times. |
| 163 | /// |
| 164 | /// \param addr The address to try to bind to the server (eg, localhost:1234, |
| 165 | /// 192.168.1.1:31416, [::1]:27182, etc.). |
| 166 | /// \params creds The credentials associated with the server. |
| 167 | /// |
| 168 | /// \return bound port number on sucess, 0 on failure. |
| 169 | /// |
| 170 | /// \warning It's an error to call this method on an already started server. |
David Garcia Quintas | f3ddb7c | 2016-01-20 16:02:22 -0800 | [diff] [blame] | 171 | int AddListeningPort(const grpc::string& addr, |
Vijay Pai | c0b2acb | 2016-11-01 16:31:56 -0700 | [diff] [blame] | 172 | ServerCredentials* creds) override; |
Craig Tiller | d6599a3 | 2015-09-03 09:37:02 -0700 | [diff] [blame] | 173 | |
| 174 | /// Start the server. |
| 175 | /// |
| 176 | /// \param cqs Completion queues for handling asynchronous services. The |
| 177 | /// caller is required to keep all completion queues live until the server is |
| 178 | /// destroyed. |
| 179 | /// \param num_cqs How many completion queues does \a cqs hold. |
| 180 | /// |
| 181 | /// \return true on a successful shutdown. |
Vijay Pai | c0b2acb | 2016-11-01 16:31:56 -0700 | [diff] [blame] | 182 | bool Start(ServerCompletionQueue** cqs, size_t num_cqs) override; |
Craig Tiller | d6599a3 | 2015-09-03 09:37:02 -0700 | [diff] [blame] | 183 | |
Vijay Pai | c0b2acb | 2016-11-01 16:31:56 -0700 | [diff] [blame] | 184 | void PerformOpsOnCall(CallOpSetInterface* ops, Call* call) override; |
Craig Tiller | bb5227f | 2015-02-11 13:34:48 -0800 | [diff] [blame] | 185 | |
Vijay Pai | c0b2acb | 2016-11-01 16:31:56 -0700 | [diff] [blame] | 186 | void ShutdownInternal(gpr_timespec deadline) override; |
Craig Tiller | e50e5cb | 2015-08-18 12:44:57 -0700 | [diff] [blame] | 187 | |
Vijay Pai | c0b2acb | 2016-11-01 16:31:56 -0700 | [diff] [blame] | 188 | int max_receive_message_size() const override { |
Mark D. Roth | 6980362 | 2016-09-06 08:15:36 -0700 | [diff] [blame] | 189 | return max_receive_message_size_; |
| 190 | }; |
Craig Tiller | 50a7a68 | 2015-06-04 12:53:40 -0700 | [diff] [blame] | 191 | |
Vijay Pai | c0b2acb | 2016-11-01 16:31:56 -0700 | [diff] [blame] | 192 | grpc_server* server() override { return server_; }; |
Yang Gao | 1c40233 | 2015-03-05 16:39:25 -0800 | [diff] [blame] | 193 | |
Yuchen Zeng | a42ec21 | 2016-04-29 13:03:06 -0700 | [diff] [blame] | 194 | ServerInitializer* initializer(); |
| 195 | |
Mark D. Roth | 6980362 | 2016-09-06 08:15:36 -0700 | [diff] [blame] | 196 | const int max_receive_message_size_; |
Yang Gao | 3921c56 | 2015-04-30 16:07:06 -0700 | [diff] [blame] | 197 | |
Sree Kuchibhotla | aabada9 | 2016-08-24 10:01:13 -0700 | [diff] [blame] | 198 | /// The following completion queues are ONLY used in case of Sync API i.e if |
| 199 | /// the server has any services with sync methods. The server uses these |
| 200 | /// completion queues to poll for new RPCs |
Sree Kuchibhotla | 4028d2c | 2016-09-21 10:45:33 -0700 | [diff] [blame] | 201 | std::shared_ptr<std::vector<std::unique_ptr<ServerCompletionQueue>>> |
| 202 | sync_server_cqs_; |
Sree Kuchibhotla | aabada9 | 2016-08-24 10:01:13 -0700 | [diff] [blame] | 203 | |
Sree Kuchibhotla | 8f7739b | 2016-10-13 15:12:55 -0700 | [diff] [blame] | 204 | /// List of ThreadManager instances (one for each cq in the sync_server_cqs) |
| 205 | std::vector<std::unique_ptr<SyncRequestThreadManager>> sync_req_mgrs_; |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 206 | |
| 207 | // Sever status |
Vijay Pai | 320ed13 | 2016-11-01 17:16:55 -0700 | [diff] [blame] | 208 | std::mutex mu_; |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 209 | bool started_; |
| 210 | bool shutdown_; |
Sree Kuchibhotla | 26ef574 | 2016-10-24 12:39:04 -0700 | [diff] [blame] | 211 | bool shutdown_notified_; // Was notify called on the shutdown_cv_ |
Sree Kuchibhotla | 3ea9e24 | 2016-08-22 14:15:43 -0700 | [diff] [blame] | 212 | |
Vijay Pai | 320ed13 | 2016-11-01 17:16:55 -0700 | [diff] [blame] | 213 | std::condition_variable shutdown_cv_; |
yang-g | e89dc6c | 2016-07-11 15:48:01 -0700 | [diff] [blame] | 214 | |
Craig Tiller | 6461649 | 2016-01-26 14:16:20 -0800 | [diff] [blame] | 215 | std::shared_ptr<GlobalCallbacks> global_callbacks_; |
| 216 | |
Yuchen Zeng | a42ec21 | 2016-04-29 13:03:06 -0700 | [diff] [blame] | 217 | std::vector<grpc::string> services_; |
yang-g | 9b7757d | 2015-08-13 11:15:53 -0700 | [diff] [blame] | 218 | bool has_generic_service_; |
Craig Tiller | cbd0485 | 2015-02-10 17:39:54 -0800 | [diff] [blame] | 219 | |
Sree Kuchibhotla | 385c9b2 | 2016-10-18 16:26:38 -0700 | [diff] [blame] | 220 | // Pointer to the wrapped grpc_server. |
yang-g | eb62c94 | 2016-02-17 15:37:25 -0800 | [diff] [blame] | 221 | grpc_server* server_; |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 222 | |
Yuchen Zeng | a42ec21 | 2016-04-29 13:03:06 -0700 | [diff] [blame] | 223 | std::unique_ptr<ServerInitializer> server_initializer_; |
yang-g | 8d668d8 | 2016-12-01 15:09:28 -0800 | [diff] [blame] | 224 | |
| 225 | std::unique_ptr<HealthCheckServiceInterface> health_check_service_; |
yang-g | ad32764 | 2016-12-12 14:32:09 -0800 | [diff] [blame] | 226 | bool health_check_service_disabled_; |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 227 | }; |
| 228 | |
| 229 | } // namespace grpc |
| 230 | |
Nicolas "Pixel" Noble | 1ff52d5 | 2015-03-01 05:24:36 +0100 | [diff] [blame] | 231 | #endif // GRPCXX_SERVER_H |