blob: 906daf13709417c80af3c01e0ca4627af40ab453 [file] [log] [blame]
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -08001/*
2 *
Craig Tiller06059952015-02-18 08:34:56 -08003 * Copyright 2015, Google Inc.
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -08004 * 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" Noble1ff52d52015-03-01 05:24:36 +010034#ifndef GRPCXX_SERVER_BUILDER_H
35#define GRPCXX_SERVER_BUILDER_H
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -080036
37#include <memory>
38#include <vector>
39
40#include <grpc++/config.h>
41
42namespace grpc {
43
Yang Gao49996492015-03-12 16:40:19 -070044class AsyncGenericService;
Craig Tiller14a65f92015-02-09 13:13:14 -080045class AsynchronousService;
Craig Tiller8c8d0aa2015-02-12 11:38:36 -080046class CompletionQueue;
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -080047class RpcService;
48class Server;
Craig Tillerf9e6adf2015-05-06 11:45:59 -070049class ServerCompletionQueue;
yangg9e21f722014-12-08 15:49:52 -080050class ServerCredentials;
Craig Tiller14a65f92015-02-09 13:13:14 -080051class SynchronousService;
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -080052class ThreadPoolInterface;
53
54class ServerBuilder {
55 public:
56 ServerBuilder();
57
58 // Register a service. This call does not take ownership of the service.
59 // The service must exist for the lifetime of the Server instance returned by
60 // BuildAndStart().
Craig Tiller2ee8f0b2015-07-08 07:53:20 -070061 // Matches requests with any :authority
Craig Tiller14a65f92015-02-09 13:13:14 -080062 void RegisterService(SynchronousService* service);
63
Craig Tiller2ee8f0b2015-07-08 07:53:20 -070064 // Register an asynchronous service.
Craig Tiller8c8d0aa2015-02-12 11:38:36 -080065 // This call does not take ownership of the service or completion queue.
66 // The service and completion queuemust exist for the lifetime of the Server
67 // instance returned by BuildAndStart().
Craig Tiller2ee8f0b2015-07-08 07:53:20 -070068 // Matches requests with any :authority
Craig Tiller8c8d0aa2015-02-12 11:38:36 -080069 void RegisterAsyncService(AsynchronousService* service);
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -080070
Yang Gao005eb882015-03-11 22:17:13 -070071 // Register a generic service.
Craig Tiller2ee8f0b2015-07-08 07:53:20 -070072 // Matches requests with any :authority
Yang Gao49996492015-03-12 16:40:19 -070073 void RegisterAsyncGenericService(AsyncGenericService* service);
Craig Tillerdb57c4f2015-02-24 10:34:47 -080074
Craig Tiller822d2c72015-07-07 16:08:00 -070075 // Register a service. This call does not take ownership of the service.
76 // The service must exist for the lifetime of the Server instance returned by
77 // BuildAndStart().
Craig Tiller2ee8f0b2015-07-08 07:53:20 -070078 // Only matches requests with :authority \a host
Craig Tillerd6c98df2015-08-18 09:33:44 -070079 void RegisterService(const grpc::string& host, SynchronousService* service);
Craig Tiller822d2c72015-07-07 16:08:00 -070080
Craig Tiller2ee8f0b2015-07-08 07:53:20 -070081 // Register an asynchronous service.
Craig Tiller822d2c72015-07-07 16:08:00 -070082 // This call does not take ownership of the service or completion queue.
83 // The service and completion queuemust exist for the lifetime of the Server
84 // instance returned by BuildAndStart().
Craig Tiller2ee8f0b2015-07-08 07:53:20 -070085 // Only matches requests with :authority \a host
Craig Tillerd6c98df2015-08-18 09:33:44 -070086 void RegisterAsyncService(const grpc::string& host,
Craig Tiller822d2c72015-07-07 16:08:00 -070087 AsynchronousService* service);
88
Yang Gao3921c562015-04-30 16:07:06 -070089 // Set max message size in bytes.
90 void SetMaxMessageSize(int max_message_size) {
91 max_message_size_ = max_message_size;
92 }
93
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -080094 // Add a listening port. Can be called multiple times.
Nicolas Noblecfd60732015-03-18 16:27:43 -070095 void AddListeningPort(const grpc::string& addr,
96 std::shared_ptr<ServerCredentials> creds,
97 int* selected_port = nullptr);
yangg9e21f722014-12-08 15:49:52 -080098
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -080099 // Set the thread pool used for running appliation rpc handlers.
100 // Does not take ownership.
101 void SetThreadPool(ThreadPoolInterface* thread_pool);
102
Craig Tillerf9e6adf2015-05-06 11:45:59 -0700103 // Add a completion queue for handling asynchronous services
104 // Caller is required to keep this completion queue live until calling
105 // BuildAndStart()
106 std::unique_ptr<ServerCompletionQueue> AddCompletionQueue();
107
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -0800108 // Return a running server which is ready for processing rpcs.
109 std::unique_ptr<Server> BuildAndStart();
110
111 private:
Craig Tiller42bc87c2015-02-23 08:50:19 -0800112 struct Port {
113 grpc::string addr;
114 std::shared_ptr<ServerCredentials> creds;
115 int* selected_port;
116 };
117
Craig Tiller822d2c72015-07-07 16:08:00 -0700118 typedef std::unique_ptr<grpc::string> HostString;
Craig Tillerd6c98df2015-08-18 09:33:44 -0700119 template <class T>
120 struct NamedService {
Craig Tiller822d2c72015-07-07 16:08:00 -0700121 explicit NamedService(T* s) : service(s) {}
Craig Tillerd6c98df2015-08-18 09:33:44 -0700122 NamedService(const grpc::string& h, T* s)
Craig Tiller822d2c72015-07-07 16:08:00 -0700123 : host(new grpc::string(h)), service(s) {}
124 HostString host;
125 T* service;
126 };
127
Yang Gao3921c562015-04-30 16:07:06 -0700128 int max_message_size_;
Craig Tillerd9b6fcf2015-07-07 16:28:20 -0700129 std::vector<std::unique_ptr<NamedService<RpcService>>> services_;
Craig Tillerd6c98df2015-08-18 09:33:44 -0700130 std::vector<std::unique_ptr<NamedService<AsynchronousService>>>
131 async_services_;
Craig Tiller42bc87c2015-02-23 08:50:19 -0800132 std::vector<Port> ports_;
Craig Tillerf9e6adf2015-05-06 11:45:59 -0700133 std::vector<ServerCompletionQueue*> cqs_;
yangg9e21f722014-12-08 15:49:52 -0800134 std::shared_ptr<ServerCredentials> creds_;
Yang Gao49996492015-03-12 16:40:19 -0700135 AsyncGenericService* generic_service_;
Craig Tillercf133f42015-02-26 14:05:56 -0800136 ThreadPoolInterface* thread_pool_;
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -0800137};
138
139} // namespace grpc
140
Nicolas "Pixel" Noble1ff52d52015-03-01 05:24:36 +0100141#endif // GRPCXX_SERVER_BUILDER_H