Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 1 | /* |
| 2 | * |
Sree Kuchibhotla | 0190712 | 2016-04-21 15:09:13 -0700 | [diff] [blame^] | 3 | * Copyright 2015-2016, 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 | |
yang-g | a23f17b | 2015-11-25 10:21:05 -0800 | [diff] [blame] | 40 | #include <grpc++/impl/server_builder_option.h> |
yang-g | 9e2f90c | 2015-08-21 15:35:03 -0700 | [diff] [blame] | 41 | #include <grpc++/support/config.h> |
yang-g | a23f17b | 2015-11-25 10:21:05 -0800 | [diff] [blame] | 42 | #include <grpc/compression.h> |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 43 | |
| 44 | namespace grpc { |
| 45 | |
Yang Gao | 4999649 | 2015-03-12 16:40:19 -0700 | [diff] [blame] | 46 | class AsyncGenericService; |
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 | 15f383c | 2016-01-07 12:45:32 -0800 | [diff] [blame] | 52 | class Service; |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 53 | |
Craig Tiller | d6599a3 | 2015-09-03 09:37:02 -0700 | [diff] [blame] | 54 | /// A builder class for the creation and startup of \a grpc::Server instances. |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 55 | class ServerBuilder { |
| 56 | public: |
| 57 | ServerBuilder(); |
| 58 | |
Craig Tiller | d6599a3 | 2015-09-03 09:37:02 -0700 | [diff] [blame] | 59 | /// Register a service. This call does not take ownership of the service. |
| 60 | /// The service must exist for the lifetime of the \a Server instance returned |
| 61 | /// by \a BuildAndStart(). |
| 62 | /// Matches requests with any :authority |
Craig Tiller | 15f383c | 2016-01-07 12:45:32 -0800 | [diff] [blame] | 63 | void RegisterService(Service* service); |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 64 | |
Craig Tiller | d6599a3 | 2015-09-03 09:37:02 -0700 | [diff] [blame] | 65 | /// Register a generic service. |
| 66 | /// Matches requests with any :authority |
Yang Gao | 4999649 | 2015-03-12 16:40:19 -0700 | [diff] [blame] | 67 | void RegisterAsyncGenericService(AsyncGenericService* service); |
Craig Tiller | db57c4f | 2015-02-24 10:34:47 -0800 | [diff] [blame] | 68 | |
Craig Tiller | d6599a3 | 2015-09-03 09:37:02 -0700 | [diff] [blame] | 69 | /// Register a service. This call does not take ownership of the service. |
| 70 | /// The service must exist for the lifetime of the \a Server instance returned |
| 71 | /// by BuildAndStart(). |
| 72 | /// Only matches requests with :authority \a host |
Craig Tiller | 15f383c | 2016-01-07 12:45:32 -0800 | [diff] [blame] | 73 | void RegisterService(const grpc::string& host, Service* service); |
Craig Tiller | 822d2c7 | 2015-07-07 16:08:00 -0700 | [diff] [blame] | 74 | |
Craig Tiller | d6599a3 | 2015-09-03 09:37:02 -0700 | [diff] [blame] | 75 | /// Set max message size in bytes. |
Yang Gao | 3921c56 | 2015-04-30 16:07:06 -0700 | [diff] [blame] | 76 | void SetMaxMessageSize(int max_message_size) { |
| 77 | max_message_size_ = max_message_size; |
| 78 | } |
| 79 | |
David Garcia Quintas | 49dd250 | 2015-09-08 16:01:09 -0700 | [diff] [blame] | 80 | /// Set the compression options to be used by the server. |
| 81 | void SetCompressionOptions(const grpc_compression_options& options) { |
| 82 | compression_options_ = options; |
| 83 | } |
| 84 | |
yang-g | a23f17b | 2015-11-25 10:21:05 -0800 | [diff] [blame] | 85 | void SetOption(std::unique_ptr<ServerBuilderOption> option); |
| 86 | |
Craig Tiller | d6599a3 | 2015-09-03 09:37:02 -0700 | [diff] [blame] | 87 | /// Tries to bind \a server to the given \a addr. |
| 88 | /// |
| 89 | /// It can be invoked multiple times. |
| 90 | /// |
| 91 | /// \param addr The address to try to bind to the server (eg, localhost:1234, |
| 92 | /// 192.168.1.1:31416, [::1]:27182, etc.). |
| 93 | /// \params creds The credentials associated with the server. |
| 94 | /// \param selected_port[out] Upon success, updated to contain the port |
| 95 | /// number. \a nullptr otherwise. |
| 96 | /// |
| 97 | // TODO(dgq): the "port" part seems to be a misnomer. |
Nicolas Noble | cfd6073 | 2015-03-18 16:27:43 -0700 | [diff] [blame] | 98 | void AddListeningPort(const grpc::string& addr, |
| 99 | std::shared_ptr<ServerCredentials> creds, |
| 100 | int* selected_port = nullptr); |
yangg | 9e21f72 | 2014-12-08 15:49:52 -0800 | [diff] [blame] | 101 | |
Craig Tiller | d6599a3 | 2015-09-03 09:37:02 -0700 | [diff] [blame] | 102 | /// Add a completion queue for handling asynchronous services |
| 103 | /// Caller is required to keep this completion queue live until |
| 104 | /// the server is destroyed. |
Sree Kuchibhotla | 1f5e262 | 2016-04-21 12:28:09 -0700 | [diff] [blame] | 105 | /// |
| 106 | /// \param is_frequently_polled This is an optional parameter to inform GRPC |
| 107 | /// library about whether this completion queue would be frequently polled |
| 108 | /// (i.e by calling Next() or AsyncNext()). The default value is 'true' and is |
| 109 | /// the recommended setting. Setting this to 'false' (i.e not polling the |
| 110 | /// completion queue frequently) will have a significantly negative |
| 111 | /// performance impact and hence should not be used in production use cases. |
| 112 | std::unique_ptr<ServerCompletionQueue> AddCompletionQueue( |
| 113 | bool is_frequently_polled = true); |
Craig Tiller | f9e6adf | 2015-05-06 11:45:59 -0700 | [diff] [blame] | 114 | |
Craig Tiller | d6599a3 | 2015-09-03 09:37:02 -0700 | [diff] [blame] | 115 | /// Return a running server which is ready for processing calls. |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 116 | std::unique_ptr<Server> BuildAndStart(); |
| 117 | |
| 118 | private: |
Craig Tiller | 42bc87c | 2015-02-23 08:50:19 -0800 | [diff] [blame] | 119 | struct Port { |
| 120 | grpc::string addr; |
| 121 | std::shared_ptr<ServerCredentials> creds; |
| 122 | int* selected_port; |
| 123 | }; |
| 124 | |
Craig Tiller | 822d2c7 | 2015-07-07 16:08:00 -0700 | [diff] [blame] | 125 | typedef std::unique_ptr<grpc::string> HostString; |
Craig Tiller | d6c98df | 2015-08-18 09:33:44 -0700 | [diff] [blame] | 126 | struct NamedService { |
Craig Tiller | 15f383c | 2016-01-07 12:45:32 -0800 | [diff] [blame] | 127 | explicit NamedService(Service* s) : service(s) {} |
| 128 | NamedService(const grpc::string& h, Service* s) |
Craig Tiller | 822d2c7 | 2015-07-07 16:08:00 -0700 | [diff] [blame] | 129 | : host(new grpc::string(h)), service(s) {} |
| 130 | HostString host; |
Craig Tiller | 15f383c | 2016-01-07 12:45:32 -0800 | [diff] [blame] | 131 | Service* service; |
Craig Tiller | 822d2c7 | 2015-07-07 16:08:00 -0700 | [diff] [blame] | 132 | }; |
| 133 | |
Yang Gao | 3921c56 | 2015-04-30 16:07:06 -0700 | [diff] [blame] | 134 | int max_message_size_; |
David Garcia Quintas | beac88c | 2015-08-10 13:39:52 -0700 | [diff] [blame] | 135 | grpc_compression_options compression_options_; |
yang-g | a23f17b | 2015-11-25 10:21:05 -0800 | [diff] [blame] | 136 | std::vector<std::unique_ptr<ServerBuilderOption>> options_; |
Craig Tiller | 15f383c | 2016-01-07 12:45:32 -0800 | [diff] [blame] | 137 | std::vector<std::unique_ptr<NamedService>> services_; |
Craig Tiller | 42bc87c | 2015-02-23 08:50:19 -0800 | [diff] [blame] | 138 | std::vector<Port> ports_; |
Craig Tiller | f9e6adf | 2015-05-06 11:45:59 -0700 | [diff] [blame] | 139 | std::vector<ServerCompletionQueue*> cqs_; |
yangg | 9e21f72 | 2014-12-08 15:49:52 -0800 | [diff] [blame] | 140 | std::shared_ptr<ServerCredentials> creds_; |
Yang Gao | 4999649 | 2015-03-12 16:40:19 -0700 | [diff] [blame] | 141 | AsyncGenericService* generic_service_; |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 142 | }; |
| 143 | |
| 144 | } // namespace grpc |
| 145 | |
Nicolas "Pixel" Noble | 1ff52d5 | 2015-03-01 05:24:36 +0100 | [diff] [blame] | 146 | #endif // GRPCXX_SERVER_BUILDER_H |