GRPC C++  0.11.0.0
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
server_builder.h
Go to the documentation of this file.
1 /*
2  *
3  * Copyright 2015, Google Inc.
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 
34 #ifndef GRPCXX_SERVER_BUILDER_H
35 #define GRPCXX_SERVER_BUILDER_H
36 
37 #include <memory>
38 #include <vector>
39 
40 #include <grpc++/support/config.h>
41 
42 namespace grpc {
43 
44 class AsyncGenericService;
45 class AsynchronousService;
46 class CompletionQueue;
47 class RpcService;
48 class Server;
49 class ServerCompletionQueue;
50 class ServerCredentials;
51 class SynchronousService;
52 class ThreadPoolInterface;
53 
56  public:
57  ServerBuilder();
58 
63  void RegisterService(SynchronousService* service);
64 
71 
75 
80  void RegisterService(const grpc::string& host, SynchronousService* service);
81 
87  void RegisterAsyncService(const grpc::string& host,
88  AsynchronousService* service);
89 
91  void SetMaxMessageSize(int max_message_size) {
92  max_message_size_ = max_message_size;
93  }
94 
105  // TODO(dgq): the "port" part seems to be a misnomer.
106  void AddListeningPort(const grpc::string& addr,
107  std::shared_ptr<ServerCredentials> creds,
108  int* selected_port = nullptr);
109 
113  std::unique_ptr<ServerCompletionQueue> AddCompletionQueue();
114 
116  std::unique_ptr<Server> BuildAndStart();
117 
118  private:
119  struct Port {
120  grpc::string addr;
121  std::shared_ptr<ServerCredentials> creds;
122  int* selected_port;
123  };
124 
125  typedef std::unique_ptr<grpc::string> HostString;
126  template <class T>
127  struct NamedService {
128  explicit NamedService(T* s) : service(s) {}
129  NamedService(const grpc::string& h, T* s)
130  : host(new grpc::string(h)), service(s) {}
131  HostString host;
132  T* service;
133  };
134 
135  int max_message_size_;
136  std::vector<std::unique_ptr<NamedService<RpcService>>> services_;
137  std::vector<std::unique_ptr<NamedService<AsynchronousService>>>
138  async_services_;
139  std::vector<Port> ports_;
140  std::vector<ServerCompletionQueue*> cqs_;
141  std::shared_ptr<ServerCredentials> creds_;
142  AsyncGenericService* generic_service_;
143  ThreadPoolInterface* thread_pool_;
144 };
145 
146 } // namespace grpc
147 
148 #endif // GRPCXX_SERVER_BUILDER_H
std::string string
Definition: config.h:112
void RegisterAsyncService(AsynchronousService *service)
Register an asynchronous service.
Definition: service_type.h:68
void AddListeningPort(const grpc::string &addr, std::shared_ptr< ServerCredentials > creds, int *selected_port=nullptr)
Tries to bind server to the given addr.
void SetMaxMessageSize(int max_message_size)
Set max message size in bytes.
Definition: server_builder.h:91
Definition: async_generic_service.h:59
Definition: service_type.h:51
std::unique_ptr< Server > BuildAndStart()
Return a running server which is ready for processing calls.
std::unique_ptr< ServerCompletionQueue > AddCompletionQueue()
Add a completion queue for handling asynchronous services Caller is required to keep this completion ...
void RegisterAsyncGenericService(AsyncGenericService *service)
Register a generic service.
A builder class for the creation and startup of grpc::Server instances.
Definition: server_builder.h:55
void RegisterService(SynchronousService *service)
Register a service.