blob: 7155c7fd46237d535c7824d85c92c62dc734c011 [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;
yangg9e21f722014-12-08 15:49:52 -080049class ServerCredentials;
Craig Tiller14a65f92015-02-09 13:13:14 -080050class SynchronousService;
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -080051class ThreadPoolInterface;
52
53class ServerBuilder {
54 public:
55 ServerBuilder();
56
57 // Register a service. This call does not take ownership of the service.
58 // The service must exist for the lifetime of the Server instance returned by
59 // BuildAndStart().
Craig Tiller14a65f92015-02-09 13:13:14 -080060 void RegisterService(SynchronousService* service);
61
Craig Tiller8c8d0aa2015-02-12 11:38:36 -080062 // Register an asynchronous service. New calls will be delevered to cq.
63 // This call does not take ownership of the service or completion queue.
64 // The service and completion queuemust exist for the lifetime of the Server
65 // instance returned by BuildAndStart().
66 void RegisterAsyncService(AsynchronousService* service);
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -080067
Yang Gao005eb882015-03-11 22:17:13 -070068 // Register a generic service.
Yang Gao49996492015-03-12 16:40:19 -070069 void RegisterAsyncGenericService(AsyncGenericService* service);
Craig Tillerdb57c4f2015-02-24 10:34:47 -080070
Yang Gao3921c562015-04-30 16:07:06 -070071 // Set max message size in bytes.
72 void SetMaxMessageSize(int max_message_size) {
73 max_message_size_ = max_message_size;
74 }
75
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -080076 // Add a listening port. Can be called multiple times.
Nicolas Noblecfd60732015-03-18 16:27:43 -070077 void AddListeningPort(const grpc::string& addr,
78 std::shared_ptr<ServerCredentials> creds,
79 int* selected_port = nullptr);
yangg9e21f722014-12-08 15:49:52 -080080
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -080081 // Set the thread pool used for running appliation rpc handlers.
82 // Does not take ownership.
83 void SetThreadPool(ThreadPoolInterface* thread_pool);
84
85 // Return a running server which is ready for processing rpcs.
86 std::unique_ptr<Server> BuildAndStart();
87
88 private:
Craig Tiller42bc87c2015-02-23 08:50:19 -080089 struct Port {
90 grpc::string addr;
91 std::shared_ptr<ServerCredentials> creds;
92 int* selected_port;
93 };
94
Yang Gao3921c562015-04-30 16:07:06 -070095 int max_message_size_;
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -080096 std::vector<RpcService*> services_;
Craig Tiller14a65f92015-02-09 13:13:14 -080097 std::vector<AsynchronousService*> async_services_;
Craig Tiller42bc87c2015-02-23 08:50:19 -080098 std::vector<Port> ports_;
yangg9e21f722014-12-08 15:49:52 -080099 std::shared_ptr<ServerCredentials> creds_;
Yang Gao49996492015-03-12 16:40:19 -0700100 AsyncGenericService* generic_service_;
Craig Tillercf133f42015-02-26 14:05:56 -0800101 ThreadPoolInterface* thread_pool_;
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -0800102};
103
104} // namespace grpc
105
Nicolas "Pixel" Noble1ff52d52015-03-01 05:24:36 +0100106#endif // GRPCXX_SERVER_BUILDER_H