blob: 5566002dc22c5127adf19117ef82a7c369442bb7 [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
Craig Tiller14a65f92015-02-09 13:13:14 -080044class AsynchronousService;
Craig Tiller8c8d0aa2015-02-12 11:38:36 -080045class CompletionQueue;
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -080046class RpcService;
47class Server;
yangg9e21f722014-12-08 15:49:52 -080048class ServerCredentials;
Craig Tiller14a65f92015-02-09 13:13:14 -080049class SynchronousService;
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -080050class ThreadPoolInterface;
51
52class ServerBuilder {
53 public:
54 ServerBuilder();
55
56 // Register a service. This call does not take ownership of the service.
57 // The service must exist for the lifetime of the Server instance returned by
58 // BuildAndStart().
Craig Tiller14a65f92015-02-09 13:13:14 -080059 void RegisterService(SynchronousService* service);
60
Craig Tiller8c8d0aa2015-02-12 11:38:36 -080061 // Register an asynchronous service. New calls will be delevered to cq.
62 // This call does not take ownership of the service or completion queue.
63 // The service and completion queuemust exist for the lifetime of the Server
64 // instance returned by BuildAndStart().
65 void RegisterAsyncService(AsynchronousService* service);
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -080066
67 // Add a listening port. Can be called multiple times.
68 void AddPort(const grpc::string& addr);
69
yangg9e21f722014-12-08 15:49:52 -080070 // Set a ServerCredentials. Can only be called once.
71 // TODO(yangg) move this to be part of AddPort
72 void SetCredentials(const std::shared_ptr<ServerCredentials>& creds);
73
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -080074 // Set the thread pool used for running appliation rpc handlers.
75 // Does not take ownership.
76 void SetThreadPool(ThreadPoolInterface* thread_pool);
77
78 // Return a running server which is ready for processing rpcs.
79 std::unique_ptr<Server> BuildAndStart();
80
81 private:
82 std::vector<RpcService*> services_;
Craig Tiller14a65f92015-02-09 13:13:14 -080083 std::vector<AsynchronousService*> async_services_;
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -080084 std::vector<grpc::string> ports_;
yangg9e21f722014-12-08 15:49:52 -080085 std::shared_ptr<ServerCredentials> creds_;
Craig Tillercf133f42015-02-26 14:05:56 -080086 ThreadPoolInterface* thread_pool_;
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -080087};
88
89} // namespace grpc
90
Nicolas "Pixel" Noble1ff52d52015-03-01 05:24:36 +010091#endif // GRPCXX_SERVER_BUILDER_H