Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 1 | /* |
| 2 | * |
Craig Tiller | 0605995 | 2015-02-18 08:34:56 -0800 | [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_BUILDER_H |
| 35 | #define GRPCXX_SERVER_BUILDER_H |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 36 | |
| 37 | #include <memory> |
| 38 | #include <vector> |
| 39 | |
David Garcia Quintas | beac88c | 2015-08-10 13:39:52 -0700 | [diff] [blame^] | 40 | #include <grpc/compression.h> |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 41 | #include <grpc++/config.h> |
| 42 | |
| 43 | namespace grpc { |
| 44 | |
Yang Gao | 4999649 | 2015-03-12 16:40:19 -0700 | [diff] [blame] | 45 | class AsyncGenericService; |
Craig Tiller | 14a65f9 | 2015-02-09 13:13:14 -0800 | [diff] [blame] | 46 | class AsynchronousService; |
Craig Tiller | 8c8d0aa | 2015-02-12 11:38:36 -0800 | [diff] [blame] | 47 | class CompletionQueue; |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 48 | class RpcService; |
| 49 | class Server; |
Craig Tiller | f9e6adf | 2015-05-06 11:45:59 -0700 | [diff] [blame] | 50 | class ServerCompletionQueue; |
yangg | 9e21f72 | 2014-12-08 15:49:52 -0800 | [diff] [blame] | 51 | class ServerCredentials; |
Craig Tiller | 14a65f9 | 2015-02-09 13:13:14 -0800 | [diff] [blame] | 52 | class SynchronousService; |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 53 | class ThreadPoolInterface; |
| 54 | |
| 55 | class ServerBuilder { |
| 56 | public: |
| 57 | ServerBuilder(); |
| 58 | |
| 59 | // Register a service. This call does not take ownership of the service. |
| 60 | // The service must exist for the lifetime of the Server instance returned by |
| 61 | // BuildAndStart(). |
Craig Tiller | 2ee8f0b | 2015-07-08 07:53:20 -0700 | [diff] [blame] | 62 | // Matches requests with any :authority |
David Garcia Quintas | beac88c | 2015-08-10 13:39:52 -0700 | [diff] [blame^] | 63 | ServerBuilder& RegisterService(SynchronousService* service); |
Craig Tiller | 14a65f9 | 2015-02-09 13:13:14 -0800 | [diff] [blame] | 64 | |
Craig Tiller | 2ee8f0b | 2015-07-08 07:53:20 -0700 | [diff] [blame] | 65 | // Register an asynchronous service. |
Craig Tiller | 8c8d0aa | 2015-02-12 11:38:36 -0800 | [diff] [blame] | 66 | // This call does not take ownership of the service or completion queue. |
| 67 | // The service and completion queuemust exist for the lifetime of the Server |
| 68 | // instance returned by BuildAndStart(). |
Craig Tiller | 2ee8f0b | 2015-07-08 07:53:20 -0700 | [diff] [blame] | 69 | // Matches requests with any :authority |
David Garcia Quintas | beac88c | 2015-08-10 13:39:52 -0700 | [diff] [blame^] | 70 | ServerBuilder& RegisterAsyncService(AsynchronousService* service); |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 71 | |
Yang Gao | 005eb88 | 2015-03-11 22:17:13 -0700 | [diff] [blame] | 72 | // Register a generic service. |
Craig Tiller | 2ee8f0b | 2015-07-08 07:53:20 -0700 | [diff] [blame] | 73 | // Matches requests with any :authority |
David Garcia Quintas | beac88c | 2015-08-10 13:39:52 -0700 | [diff] [blame^] | 74 | ServerBuilder& RegisterAsyncGenericService(AsyncGenericService* service); |
Craig Tiller | db57c4f | 2015-02-24 10:34:47 -0800 | [diff] [blame] | 75 | |
Craig Tiller | 822d2c7 | 2015-07-07 16:08:00 -0700 | [diff] [blame] | 76 | // Register a service. This call does not take ownership of the service. |
| 77 | // The service must exist for the lifetime of the Server instance returned by |
| 78 | // BuildAndStart(). |
Craig Tiller | 2ee8f0b | 2015-07-08 07:53:20 -0700 | [diff] [blame] | 79 | // Only matches requests with :authority \a host |
David Garcia Quintas | beac88c | 2015-08-10 13:39:52 -0700 | [diff] [blame^] | 80 | ServerBuilder& RegisterService(const grpc::string& host, |
Craig Tiller | 822d2c7 | 2015-07-07 16:08:00 -0700 | [diff] [blame] | 81 | SynchronousService* service); |
| 82 | |
Craig Tiller | 2ee8f0b | 2015-07-08 07:53:20 -0700 | [diff] [blame] | 83 | // Register an asynchronous service. |
Craig Tiller | 822d2c7 | 2015-07-07 16:08:00 -0700 | [diff] [blame] | 84 | // This call does not take ownership of the service or completion queue. |
| 85 | // The service and completion queuemust exist for the lifetime of the Server |
| 86 | // instance returned by BuildAndStart(). |
Craig Tiller | 2ee8f0b | 2015-07-08 07:53:20 -0700 | [diff] [blame] | 87 | // Only matches requests with :authority \a host |
David Garcia Quintas | beac88c | 2015-08-10 13:39:52 -0700 | [diff] [blame^] | 88 | ServerBuilder& RegisterAsyncService(const grpc::string& host, |
Craig Tiller | 822d2c7 | 2015-07-07 16:08:00 -0700 | [diff] [blame] | 89 | AsynchronousService* service); |
| 90 | |
Yang Gao | 3921c56 | 2015-04-30 16:07:06 -0700 | [diff] [blame] | 91 | // Set max message size in bytes. |
David Garcia Quintas | beac88c | 2015-08-10 13:39:52 -0700 | [diff] [blame^] | 92 | ServerBuilder& SetMaxMessageSize(int max_message_size); |
Yang Gao | 3921c56 | 2015-04-30 16:07:06 -0700 | [diff] [blame] | 93 | |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 94 | // Add a listening port. Can be called multiple times. |
David Garcia Quintas | beac88c | 2015-08-10 13:39:52 -0700 | [diff] [blame^] | 95 | ServerBuilder& AddListeningPort(const grpc::string& addr, |
Nicolas Noble | cfd6073 | 2015-03-18 16:27:43 -0700 | [diff] [blame] | 96 | std::shared_ptr<ServerCredentials> creds, |
| 97 | int* selected_port = nullptr); |
yangg | 9e21f72 | 2014-12-08 15:49:52 -0800 | [diff] [blame] | 98 | |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 99 | // Set the thread pool used for running appliation rpc handlers. |
| 100 | // Does not take ownership. |
David Garcia Quintas | beac88c | 2015-08-10 13:39:52 -0700 | [diff] [blame^] | 101 | ServerBuilder& SetThreadPool(ThreadPoolInterface* thread_pool); |
| 102 | |
| 103 | // Set the compression options to be used by the server. |
| 104 | ServerBuilder& SetCompressionOptions(const grpc_compression_options& options); |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 105 | |
Craig Tiller | f9e6adf | 2015-05-06 11:45:59 -0700 | [diff] [blame] | 106 | // Add a completion queue for handling asynchronous services |
| 107 | // Caller is required to keep this completion queue live until calling |
| 108 | // BuildAndStart() |
| 109 | std::unique_ptr<ServerCompletionQueue> AddCompletionQueue(); |
| 110 | |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 111 | // Return a running server which is ready for processing rpcs. |
| 112 | std::unique_ptr<Server> BuildAndStart(); |
| 113 | |
| 114 | private: |
Craig Tiller | 42bc87c | 2015-02-23 08:50:19 -0800 | [diff] [blame] | 115 | struct Port { |
| 116 | grpc::string addr; |
| 117 | std::shared_ptr<ServerCredentials> creds; |
| 118 | int* selected_port; |
| 119 | }; |
| 120 | |
Craig Tiller | 822d2c7 | 2015-07-07 16:08:00 -0700 | [diff] [blame] | 121 | typedef std::unique_ptr<grpc::string> HostString; |
| 122 | template <class T> struct NamedService { |
| 123 | explicit NamedService(T* s) : service(s) {} |
Craig Tiller | b09caa9 | 2015-07-08 07:53:47 -0700 | [diff] [blame] | 124 | NamedService(const grpc::string& h, T *s) |
Craig Tiller | 822d2c7 | 2015-07-07 16:08:00 -0700 | [diff] [blame] | 125 | : host(new grpc::string(h)), service(s) {} |
| 126 | HostString host; |
| 127 | T* service; |
| 128 | }; |
| 129 | |
Yang Gao | 3921c56 | 2015-04-30 16:07:06 -0700 | [diff] [blame] | 130 | int max_message_size_; |
David Garcia Quintas | beac88c | 2015-08-10 13:39:52 -0700 | [diff] [blame^] | 131 | grpc_compression_options compression_options_; |
Craig Tiller | d9b6fcf | 2015-07-07 16:28:20 -0700 | [diff] [blame] | 132 | std::vector<std::unique_ptr<NamedService<RpcService>>> services_; |
| 133 | std::vector<std::unique_ptr<NamedService<AsynchronousService>>> async_services_; |
Craig Tiller | 42bc87c | 2015-02-23 08:50:19 -0800 | [diff] [blame] | 134 | std::vector<Port> ports_; |
Craig Tiller | f9e6adf | 2015-05-06 11:45:59 -0700 | [diff] [blame] | 135 | std::vector<ServerCompletionQueue*> cqs_; |
yangg | 9e21f72 | 2014-12-08 15:49:52 -0800 | [diff] [blame] | 136 | std::shared_ptr<ServerCredentials> creds_; |
Yang Gao | 4999649 | 2015-03-12 16:40:19 -0700 | [diff] [blame] | 137 | AsyncGenericService* generic_service_; |
Craig Tiller | cf133f4 | 2015-02-26 14:05:56 -0800 | [diff] [blame] | 138 | ThreadPoolInterface* thread_pool_; |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 139 | }; |
| 140 | |
| 141 | } // namespace grpc |
| 142 | |
Nicolas "Pixel" Noble | 1ff52d5 | 2015-03-01 05:24:36 +0100 | [diff] [blame] | 143 | #endif // GRPCXX_SERVER_BUILDER_H |