server_builder_plugin.h 2.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970
  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. #ifndef GRPCPP_IMPL_SERVER_BUILDER_PLUGIN_H
  19. #define GRPCPP_IMPL_SERVER_BUILDER_PLUGIN_H
  20. #if defined(__GNUC__)
  21. #pragma GCC system_header
  22. #endif
  23. #include <memory>
  24. #include <grpcpp/support/channel_arguments.h>
  25. #include <grpcpp/support/config.h>
  26. namespace grpc {
  27. class ServerBuilder;
  28. class ServerInitializer;
  29. /// This interface is meant for internal usage only. Implementations of this
  30. /// interface should add themselves to a \a ServerBuilder instance through the
  31. /// \a InternalAddPluginFactory method.
  32. class ServerBuilderPlugin {
  33. public:
  34. virtual ~ServerBuilderPlugin() {}
  35. virtual TString name() = 0;
  36. /// UpdateServerBuilder will be called at an early stage in
  37. /// ServerBuilder::BuildAndStart(), right after the ServerBuilderOptions have
  38. /// done their updates.
  39. virtual void UpdateServerBuilder(ServerBuilder* /*builder*/) {}
  40. /// InitServer will be called in ServerBuilder::BuildAndStart(), after the
  41. /// Server instance is created.
  42. virtual void InitServer(ServerInitializer* si) = 0;
  43. /// Finish will be called at the end of ServerBuilder::BuildAndStart().
  44. virtual void Finish(ServerInitializer* si) = 0;
  45. /// ChangeArguments is an interface that can be used in
  46. /// ServerBuilderOption::UpdatePlugins
  47. virtual void ChangeArguments(const TString& name, void* value) = 0;
  48. /// UpdateChannelArguments will be called in ServerBuilder::BuildAndStart(),
  49. /// before the Server instance is created.
  50. virtual void UpdateChannelArguments(ChannelArguments* /*args*/) {}
  51. virtual bool has_sync_methods() const { return false; }
  52. virtual bool has_async_methods() const { return false; }
  53. };
  54. } // namespace grpc
  55. #endif // GRPCPP_IMPL_SERVER_BUILDER_PLUGIN_H