Go to the documentation of this file.
19 #ifndef GRPCPP_SERVER_BUILDER_H
20 #define GRPCPP_SERVER_BUILDER_H
43 class CompletionQueue;
45 class ServerCompletionQueue;
46 class AsyncGenericService;
48 class ServerCredentials;
51 class ServerBuilderPluginTest;
55 class ExternalConnectionAcceptorImpl;
58 class CallbackGenericService;
60 namespace experimental {
126 const std::string& addr_uri,
127 std::shared_ptr<grpc::ServerCredentials> creds,
128 int* selected_port =
nullptr);
161 bool is_frequently_polled =
true);
186 max_receive_message_size_ = max_receive_message_size;
193 max_send_message_size_ = max_send_message_size;
245 std::unique_ptr<grpc::ServerBuilderPlugin> (*CreatePlugin)());
260 std::vector<std::unique_ptr<
262 interceptor_creators) {
263 builder_->interceptor_creators_ = std::move(interceptor_creators);
274 std::unique_ptr<grpc::experimental::ExternalConnectionAcceptor>
276 std::shared_ptr<ServerCredentials> creds);
281 std::shared_ptr<experimental::AuthorizationPolicyProviderInterface>
301 std::unique_ptr<grpc::ContextAllocator> context_allocator);
319 std::shared_ptr<ServerCredentials>
creds;
334 std::vector<Port>
ports() {
return ports_; }
338 std::vector<NamedService*> service_refs;
339 service_refs.reserve(services_.size());
340 for (
auto& ptr : services_) {
341 service_refs.push_back(ptr.get());
347 std::vector<grpc::ServerBuilderOption*>
options() {
348 std::vector<grpc::ServerBuilderOption*> option_refs;
349 option_refs.reserve(options_.size());
350 for (
auto& ptr : options_) {
351 option_refs.push_back(ptr.get());
358 server_config_fetcher_ = server_config_fetcher;
367 struct SyncServerSettings {
369 : num_cqs(1), min_pollers(1), max_pollers(2), cq_timeout_msec(10000) {}
386 int max_receive_message_size_;
387 int max_send_message_size_;
388 std::vector<std::unique_ptr<grpc::ServerBuilderOption>> options_;
389 std::vector<std::unique_ptr<NamedService>> services_;
390 std::vector<Port> ports_;
392 SyncServerSettings sync_server_settings_;
395 std::vector<grpc::ServerCompletionQueue*> cqs_;
397 std::shared_ptr<grpc::ServerCredentials> creds_;
398 std::vector<std::unique_ptr<grpc::ServerBuilderPlugin>> plugins_;
401 std::unique_ptr<ContextAllocator> context_allocator_;
407 } maybe_default_compression_level_;
411 } maybe_default_compression_algorithm_;
412 uint32_t enabled_compression_algorithms_bitset_;
414 std::unique_ptr<grpc::experimental::ServerInterceptorFactoryInterface>>
415 interceptor_creators_;
416 std::vector<std::shared_ptr<grpc::internal::ExternalConnectionAcceptorImpl>>
419 std::shared_ptr<experimental::AuthorizationPolicyProviderInterface>
420 authorization_provider_;
426 #endif // GRPCPP_SERVER_BUILDER_H
grpc_compression_level level
Definition: server_builder.h:406
Definition: server_builder.h:325
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:410
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:33
struct grpc_resource_quota grpc_resource_quota
Definition: grpc_types.h:400
std::vector< Port > ports()
Experimental, to be deprecated.
Definition: server_builder.h:334
NamedService(const std::string &h, grpc::Service *s)
Definition: server_builder.h:327
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:318
void set_fetcher(grpc_server_config_fetcher *server_config_fetcher)
Experimental API, subject to change.
Definition: server_builder.h:357
Descriptor of an RPC service and its various RPC methods.
Definition: service_type.h:58
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:317
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:320
friend class grpc::testing::ServerBuilderPluginTest
Definition: server_builder.h:365
Options for channel creation.
Definition: channel_arguments.h:39
@ NUM_CQS
Number of completion queues.
Definition: server_builder.h:227
ExternalConnectionType
Definition: server_builder.h:266
ByteBuffer read_buffer
Definition: server_builder.h:70
Definition: server_builder.h:67
int fd
Definition: server_builder.h:69
@ MAX_POLLERS
Maximum number of polling threads.
Definition: server_builder.h:229
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:257
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:324
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:255
Definition: async_generic_service.h:67
Definition: server_builder.h:65
@ CQ_TIMEOUT_MSEC
Completion queue timeout in milliseconds.
Definition: server_builder.h:230
ServerBuilder & SetMaxMessageSize(int max_message_size)
Definition: server_builder.h:198
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:226
std::vector< NamedService * > services()
Experimental, to be deprecated.
Definition: server_builder.h:337
Definition: server_interceptor.h:46
grpc::Service * service
Definition: server_builder.h:330
bool is_set
Definition: server_builder.h:405
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:319
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:329
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:407
virtual ~ExternalConnectionAcceptor()
Definition: server_builder.h:72
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:259
NamedService(grpc::Service *s)
Definition: server_builder.h:326
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:68
experimental_type experimental()
NOTE: The function experimental() is not stable public API.
Definition: server_builder.h:313
A builder class for the creation and startup of grpc::Server instances.
Definition: server_builder.h:84
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:185
std::vector< grpc::ServerBuilderOption * > options()
Experimental, to be deprecated.
Definition: server_builder.h:347
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:239
@ MIN_POLLERS
Minimum number of polling threads.
Definition: server_builder.h:228
ServerBuilder & SetMaxSendMessageSize(int max_send_message_size)
Set max send message size in bytes.
Definition: server_builder.h:192
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:101