aboutsummaryrefslogtreecommitdiffhomepage
path: root/include/grpc++/impl/server_builder_plugin.h
diff options
context:
space:
mode:
authorGravatar Yang Gao <yangg@google.com>2017-05-22 10:41:17 -0700
committerGravatar Yang Gao <yangg@google.com>2017-05-22 10:41:17 -0700
commit725d82274385217b5f0345e834f7fae7e76fbd84 (patch)
tree310cf74a491e11efd86e16ebfd879f9a83e5e648 /include/grpc++/impl/server_builder_plugin.h
parent21035da1c9c20b5204ad4e9f2339490b3a3b6c0f (diff)
parent495cf83c86e04567f8b907a51cc0f86f5068fab6 (diff)
merge with head
Diffstat (limited to 'include/grpc++/impl/server_builder_plugin.h')
-rw-r--r--include/grpc++/impl/server_builder_plugin.h20
1 files changed, 12 insertions, 8 deletions
diff --git a/include/grpc++/impl/server_builder_plugin.h b/include/grpc++/impl/server_builder_plugin.h
index 00d806ddb1..d940f8cc7b 100644
--- a/include/grpc++/impl/server_builder_plugin.h
+++ b/include/grpc++/impl/server_builder_plugin.h
@@ -44,27 +44,31 @@ class ServerBuilder;
class ServerInitializer;
class ChannelArguments;
+/// This interface is meant for internal usage only. Implementations of this
+/// interface should add themselves to a \a ServerBuilder instance through the
+/// \a InternalAddPluginFactory method.
class ServerBuilderPlugin {
public:
virtual ~ServerBuilderPlugin() {}
virtual grpc::string name() = 0;
- /// UpdateServerBuilder will be called at the beginning of BuildAndStart.
+ /// UpdateServerBuilder will be called at the beginning of
+ /// \a ServerBuilder::BuildAndStart().
virtual void UpdateServerBuilder(ServerBuilder* builder) {}
- // InitServer will be called in ServerBuilder::BuildAndStart(), after the
- // Server instance is created.
+ /// InitServer will be called in ServerBuilder::BuildAndStart(), after the
+ /// Server instance is created.
virtual void InitServer(ServerInitializer* si) = 0;
- // Finish will be called at the end of ServerBuilder::BuildAndStart().
+ /// Finish will be called at the end of ServerBuilder::BuildAndStart().
virtual void Finish(ServerInitializer* si) = 0;
- // ChangeArguments is an interface that can be used in
- // ServerBuilderOption::UpdatePlugins
+ /// ChangeArguments is an interface that can be used in
+ /// ServerBuilderOption::UpdatePlugins
virtual void ChangeArguments(const grpc::string& name, void* value) = 0;
- // UpdateChannelArguments will be called in ServerBuilder::BuildAndStart(),
- // before the Server instance is created.
+ /// UpdateChannelArguments will be called in ServerBuilder::BuildAndStart(),
+ /// before the Server instance is created.
virtual void UpdateChannelArguments(ChannelArguments* args) {}
virtual bool has_sync_methods() const { return false; }