GRPC C++  1.46.2
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 {
28 
29 class ServerBuilder;
30 class ServerInitializer;
31 
36  public:
37  virtual ~ServerBuilderPlugin() {}
38  virtual std::string name() = 0;
39 
43  virtual void UpdateServerBuilder(ServerBuilder* /*builder*/) {}
44 
47  virtual void InitServer(ServerInitializer* si) = 0;
48 
50  virtual void Finish(ServerInitializer* si) = 0;
51 
54  virtual void ChangeArguments(const std::string& name, void* value) = 0;
55 
58  virtual void UpdateChannelArguments(ChannelArguments* /*args*/) {}
59 
60  virtual bool has_sync_methods() const { return false; }
61  virtual bool has_async_methods() const { return false; }
62 };
63 
64 } // namespace grpc
65 
66 #endif // GRPCPP_IMPL_SERVER_BUILDER_PLUGIN_H
grpc::ServerBuilderPlugin::has_async_methods
virtual bool has_async_methods() const
Definition: server_builder_plugin.h:61
grpc::ServerBuilderPlugin::ChangeArguments
virtual void ChangeArguments(const std::string &name, void *value)=0
ChangeArguments is an interface that can be used in ServerBuilderOption::UpdatePlugins.
grpc
An Alarm posts the user-provided tag to its associated completion queue or invokes the user-provided ...
Definition: alarm.h:33
grpc::ServerInitializer
Definition: server_initializer.h:31
grpc::ServerBuilderPlugin::InitServer
virtual void InitServer(ServerInitializer *si)=0
InitServer will be called in ServerBuilder::BuildAndStart(), after the Server instance is created.
grpc::ChannelArguments
Options for channel creation.
Definition: channel_arguments.h:39
channel_arguments.h
grpc::ServerBuilderPlugin::~ServerBuilderPlugin
virtual ~ServerBuilderPlugin()
Definition: server_builder_plugin.h:37
grpc::ServerBuilderPlugin::Finish
virtual void Finish(ServerInitializer *si)=0
Finish will be called at the end of ServerBuilder::BuildAndStart().
grpc::ServerBuilderPlugin::UpdateServerBuilder
virtual void UpdateServerBuilder(ServerBuilder *)
UpdateServerBuilder will be called at an early stage in ServerBuilder::BuildAndStart(),...
Definition: server_builder_plugin.h:43
grpc::ServerBuilderPlugin::UpdateChannelArguments
virtual void UpdateChannelArguments(ChannelArguments *)
UpdateChannelArguments will be called in ServerBuilder::BuildAndStart(), before the Server instance i...
Definition: server_builder_plugin.h:58
grpc::ServerBuilderPlugin
This interface is meant for internal usage only.
Definition: server_builder_plugin.h:35
config.h
grpc::ServerBuilderPlugin::has_sync_methods
virtual bool has_sync_methods() const
Definition: server_builder_plugin.h:60
grpc::ServerBuilder
A builder class for the creation and startup of grpc::Server instances.
Definition: server_builder.h:85
grpc::ServerBuilderPlugin::name
virtual std::string name()=0