Go to the documentation of this file.
19 #ifndef GRPCPP_SERVER_BUILDER_H
20 #define GRPCPP_SERVER_BUILDER_H
44 class CompletionQueue;
46 class ServerCompletionQueue;
47 class AsyncGenericService;
49 class ServerCredentials;
52 class ServerBuilderPluginTest;
56 class ExternalConnectionAcceptorImpl;
59 class CallbackGenericService;
61 namespace experimental {
127 const std::string& addr_uri,
128 std::shared_ptr<grpc::ServerCredentials> creds,
129 int* selected_port =
nullptr);
162 bool is_frequently_polled =
true);
187 max_receive_message_size_ = max_receive_message_size;
194 max_send_message_size_ = max_send_message_size;
246 std::unique_ptr<grpc::ServerBuilderPlugin> (*CreatePlugin)());
261 std::vector<std::unique_ptr<
263 interceptor_creators) {
264 builder_->interceptor_creators_ = std::move(interceptor_creators);
275 std::unique_ptr<grpc::experimental::ExternalConnectionAcceptor>
277 std::shared_ptr<ServerCredentials> creds);
282 std::shared_ptr<experimental::AuthorizationPolicyProviderInterface>
302 std::unique_ptr<grpc::ContextAllocator> context_allocator);
320 std::shared_ptr<ServerCredentials>
creds;
335 std::vector<Port>
ports() {
return ports_; }
339 std::vector<NamedService*> service_refs;
340 service_refs.reserve(services_.size());
341 for (
auto& ptr : services_) {
342 service_refs.push_back(ptr.get());
348 std::vector<grpc::ServerBuilderOption*>
options() {
349 std::vector<grpc::ServerBuilderOption*> option_refs;
350 option_refs.reserve(options_.size());
351 for (
auto& ptr : options_) {
352 option_refs.push_back(ptr.get());
359 server_config_fetcher_ = server_config_fetcher;
368 struct SyncServerSettings {
370 : num_cqs(1), min_pollers(1), max_pollers(2), cq_timeout_msec(10000) {}
387 int max_receive_message_size_;
388 int max_send_message_size_;
389 std::vector<std::unique_ptr<grpc::ServerBuilderOption>> options_;
390 std::vector<std::unique_ptr<NamedService>> services_;
391 std::vector<Port> ports_;
393 SyncServerSettings sync_server_settings_;
396 std::vector<grpc::ServerCompletionQueue*> cqs_;
398 std::shared_ptr<grpc::ServerCredentials> creds_;
399 std::vector<std::unique_ptr<grpc::ServerBuilderPlugin>> plugins_;
402 std::unique_ptr<ContextAllocator> context_allocator_;
408 } maybe_default_compression_level_;
412 } maybe_default_compression_algorithm_;
413 uint32_t enabled_compression_algorithms_bitset_;
415 std::unique_ptr<grpc::experimental::ServerInterceptorFactoryInterface>>
416 interceptor_creators_;
417 std::vector<std::shared_ptr<grpc::internal::ExternalConnectionAcceptorImpl>>
420 std::shared_ptr<experimental::AuthorizationPolicyProviderInterface>
421 authorization_provider_;
427 #endif // GRPCPP_SERVER_BUILDER_H
grpc_compression_level level
Definition: server_builder.h:407
Definition: server_builder.h:326
virtual std::unique_ptr< grpc::Server > BuildAndStart()
Return a running server which is ready for processing calls.
grpc_compression_algorithm algorithm
Definition: server_builder.h:411
std::unique_ptr< ServerBuilderOption > MakeChannelArgumentOption(const std::string &name, const std::string &value)
Records server wide metrics to be reported to the client.
Definition: server_metric_recorder.h:42
ServerBuilder & SetDefaultCompressionAlgorithm(grpc_compression_algorithm algorithm)
The default compression algorithm to use for all channel calls in the absence of a call-specific leve...
ServerBuilder & RegisterCallbackGenericService(grpc::CallbackGenericService *service)
Register a generic service that uses the callback API.
ServerBuilder & EnableWorkaround(grpc_workaround_list id)
Enable a server workaround.
An Alarm posts the user-provided tag to its associated completion queue or invokes the user-provided ...
Definition: alarm.h:32
struct grpc_resource_quota grpc_resource_quota
Definition: grpc_types.h:739
std::vector< Port > ports()
Experimental, to be deprecated.
Definition: server_builder.h:335
NamedService(const std::string &h, grpc::Service *s)
Definition: server_builder.h:328
grpc_compression_algorithm
The various compression algorithms supported by gRPC (not sorted by compression level)
Definition: compression_types.h:60
std::unique_ptr< grpc::experimental::ExternalConnectionAcceptor > AddExternalConnectionAcceptor(ExternalConnectionType type, std::shared_ptr< ServerCredentials > creds)
Register an acceptor to handle the externally accepted connection in grpc server.
std::string addr
Definition: server_builder.h:319
void set_fetcher(grpc_server_config_fetcher *server_config_fetcher)
Experimental API, subject to change.
Definition: server_builder.h:358
Descriptor of an RPC service and its various RPC methods.
Definition: service_type.h:56
static void InternalAddPluginFactory(std::unique_ptr< grpc::ServerBuilderPlugin >(*CreatePlugin)())
For internal use only: Register a ServerBuilderPlugin factory function.
Experimental, to be deprecated.
Definition: server_builder.h:318
virtual ChannelArguments BuildChannelArgs()
Experimental API, subject to change.
struct grpc_server_config_fetcher grpc_server_config_fetcher
Definition: grpc.h:448
int * selected_port
Definition: server_builder.h:321
friend class grpc::testing::ServerBuilderPluginTest
Definition: server_builder.h:366
Options for channel creation.
Definition: channel_arguments.h:39
@ NUM_CQS
Number of completion queues.
Definition: server_builder.h:228
ExternalConnectionType
Definition: server_builder.h:267
ByteBuffer read_buffer
Definition: server_builder.h:71
Definition: server_builder.h:68
int fd
Definition: server_builder.h:70
@ MAX_POLLERS
Maximum number of polling threads.
Definition: server_builder.h:230
ServerBuilder & SetDefaultCompressionLevel(grpc_compression_level level)
The default compression level to use for all channel calls in the absence of a call-specific level.
void EnableCallMetricRecording(experimental::ServerMetricRecorder *server_metric_recorder=nullptr)
Enables per-call load reporting.
A sequence of bytes.
Definition: byte_buffer.h:60
experimental_type(ServerBuilder *builder)
Definition: server_builder.h:258
ResourceQuota represents a bound on memory and thread usage by the gRPC library.
Definition: resource_quota.h:34
std::unique_ptr< std::string > HostString
Experimental, to be deprecated.
Definition: server_builder.h:325
ServerBuilder & RegisterAsyncGenericService(grpc::AsyncGenericService *service)
Register a generic service.
NOTE: class experimental_type is not part of the public API of this class.
Definition: server_builder.h:256
Definition: async_generic_service.h:68
Definition: server_builder.h:66
@ CQ_TIMEOUT_MSEC
Completion queue timeout in milliseconds.
Definition: server_builder.h:231
ServerBuilder & SetMaxMessageSize(int max_message_size)
Definition: server_builder.h:199
ServerBuilder & SetSyncServerOption(SyncServerOption option, int value)
Only useful if this is a Synchronous server.
ServerBuilder & SetContextAllocator(std::unique_ptr< grpc::ContextAllocator > context_allocator)
Set the allocator for creating and releasing callback server context.
ServerBuilder & SetCompressionAlgorithmSupportStatus(grpc_compression_algorithm algorithm, bool enabled)
Set the support status for compression algorithms.
SyncServerOption
Options for synchronous servers.
Definition: server_builder.h:227
std::vector< NamedService * > services()
Experimental, to be deprecated.
Definition: server_builder.h:338
Definition: server_interceptor.h:44
grpc::Service * service
Definition: server_builder.h:331
bool is_set
Definition: server_builder.h:406
std::unique_ptr< grpc::ServerCompletionQueue > AddCompletionQueue(bool is_frequently_polled=true)
Add a completion queue for handling asynchronous services.
std::shared_ptr< ServerCredentials > creds
Definition: server_builder.h:320
void SetAuthorizationPolicyProvider(std::shared_ptr< experimental::AuthorizationPolicyProviderInterface > provider)
Sets server authorization policy provider in GRPC_ARG_AUTHORIZATION_POLICY_PROVIDER channel argument.
HostString host
Definition: server_builder.h:330
grpc_workaround_list
Definition: workaround_list.h:26
grpc_compression_level
Compression levels allow a party with knowledge of its peer's accepted encodings to request compressi...
Definition: compression_types.h:72
Definition: async_unary_call.h:405
virtual ~ExternalConnectionAcceptor()
Definition: server_builder.h:73
ServerBuilder & SetResourceQuota(const grpc::ResourceQuota &resource_quota)
Set the attached buffer pool for this server.
void SetInterceptorCreators(std::vector< std::unique_ptr< grpc::experimental::ServerInterceptorFactoryInterface >> interceptor_creators)
Definition: server_builder.h:260
NamedService(grpc::Service *s)
Definition: server_builder.h:327
ServerBuilder & AddListeningPort(const std::string &addr_uri, std::shared_ptr< grpc::ServerCredentials > creds, int *selected_port=nullptr)
Enlists an endpoint addr (port with an optional IP address) to bind the grpc::Server object to be cre...
virtual void HandleNewConnection(NewConnectionParameters *p)=0
int listener_fd
Definition: server_builder.h:69
experimental_type experimental()
NOTE: The function experimental() is not stable public API.
Definition: server_builder.h:314
A builder class for the creation and startup of grpc::Server instances.
Definition: server_builder.h:85
ServerBuilder & SetOption(std::unique_ptr< grpc::ServerBuilderOption > option)
ServerBuilder & SetMaxReceiveMessageSize(int max_receive_message_size)
Set max receive message size in bytes.
Definition: server_builder.h:186
std::vector< grpc::ServerBuilderOption * > options()
Experimental, to be deprecated.
Definition: server_builder.h:348
ServerBuilder & AddChannelArgument(const std::string &arg, const T &value)
Add a channel argument (an escape hatch to tuning core library parameters directly)
Definition: server_builder.h:240
@ MIN_POLLERS
Minimum number of polling threads.
Definition: server_builder.h:229
ServerBuilder & SetMaxSendMessageSize(int max_send_message_size)
Set max send message size in bytes.
Definition: server_builder.h:193
ServerBuilder & RegisterService(grpc::Service *service)
Register a service.
CallbackGenericService is the base class for generic services implemented using the callback API and ...
Definition: async_generic_service.h:102