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