GRPC C++  1.30.0
server_builder_plugin.h
Go to the documentation of this file.
1 /*
2  *
3  * Copyright 2016 gRPC authors.
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  *
17  */
18 
19 #ifndef GRPCPP_IMPL_SERVER_BUILDER_PLUGIN_H
20 #define GRPCPP_IMPL_SERVER_BUILDER_PLUGIN_H
21 
22 #include <memory>
23 
25 #include <grpcpp/support/config.h>
26 
27 namespace grpc_impl {
28 
29 class ServerBuilder;
30 class ServerInitializer;
31 } // namespace grpc_impl
32 namespace grpc {
33 
38  public:
39  virtual ~ServerBuilderPlugin() {}
40  virtual grpc::string name() = 0;
41 
45  virtual void UpdateServerBuilder(grpc_impl::ServerBuilder* /*builder*/) {}
46 
49  virtual void InitServer(grpc_impl::ServerInitializer* si) = 0;
50 
52  virtual void Finish(grpc_impl::ServerInitializer* si) = 0;
53 
56  virtual void ChangeArguments(const grpc::string& name, void* value) = 0;
57 
60  virtual void UpdateChannelArguments(ChannelArguments* /*args*/) {}
61 
62  virtual bool has_sync_methods() const { return false; }
63  virtual bool has_async_methods() const { return false; }
64 };
65 
66 } // namespace grpc
67 
68 #endif // GRPCPP_IMPL_SERVER_BUILDER_PLUGIN_H
grpc_impl::ServerBuilder
A builder class for the creation and startup of grpc::Server instances.
Definition: server_builder_impl.h:94
grpc::ServerBuilderPlugin::has_async_methods
virtual bool has_async_methods() const
Definition: server_builder_plugin.h:63
grpc::ServerBuilderPlugin::UpdateServerBuilder
virtual void UpdateServerBuilder(grpc_impl::ServerBuilder *)
UpdateServerBuilder will be called at an early stage in ServerBuilder::BuildAndStart(),...
Definition: server_builder_plugin.h:45
grpc
This header provides an object that reads bytes directly from a grpc::ByteBuffer, via the ZeroCopyInp...
Definition: alarm.h:24
grpc_impl::ServerInitializer
Definition: server_initializer_impl.h:34
grpc::ServerBuilderPlugin::InitServer
virtual void InitServer(grpc_impl::ServerInitializer *si)=0
InitServer will be called in ServerBuilder::BuildAndStart(), after the Server instance is created.
grpc::ServerBuilderPlugin::Finish
virtual void Finish(grpc_impl::ServerInitializer *si)=0
Finish will be called at the end of ServerBuilder::BuildAndStart().
grpc::ServerBuilderPlugin::ChangeArguments
virtual void ChangeArguments(const grpc::string &name, void *value)=0
ChangeArguments is an interface that can be used in ServerBuilderOption::UpdatePlugins.
channel_arguments.h
grpc::ServerBuilderPlugin::~ServerBuilderPlugin
virtual ~ServerBuilderPlugin()
Definition: server_builder_plugin.h:39
grpc_impl::ChannelArguments
Options for channel creation.
Definition: channel_arguments_impl.h:43
grpc::ServerInitializer
::grpc_impl::ServerInitializer ServerInitializer
Definition: server_initializer.h:26
grpc::ServerBuilderPlugin::UpdateChannelArguments
virtual void UpdateChannelArguments(ChannelArguments *)
UpdateChannelArguments will be called in ServerBuilder::BuildAndStart(), before the Server instance i...
Definition: server_builder_plugin.h:60
grpc::ServerBuilderPlugin
This interface is meant for internal usage only.
Definition: server_builder_plugin.h:37
config.h
grpc::string
std::string string
Definition: config.h:35
grpc_impl
An Alarm posts the user-provided tag to its associated completion queue or invokes the user-provided ...
Definition: alarm_impl.h:33
grpc::ServerBuilderPlugin::has_sync_methods
virtual bool has_sync_methods() const
Definition: server_builder_plugin.h:62
grpc::ServerBuilderPlugin::name
virtual grpc::string name()=0
grpc::ServerBuilder
::grpc_impl::ServerBuilder ServerBuilder
Definition: server_builder.h:26