Plugin developement

Server Plugin

Example:trace

go doc

  1. type PostConnAcceptPlugin
  3. type PostConnAcceptPlugin interface {
  4.     HandleConnAccept(net.Conn) (net.Conn, bool)
  5. }
  7. PostConnAcceptPlugin represents connection accept plugin. if returns false, it means subsequent IPostConnAcceptPlugins should not contiune to handle this conn and this conn has been closed.
  8. type PostReadRequestPlugin
  10. type PostReadRequestPlugin interface {
  11.     PostReadRequest(ctx context.Context, r *protocol.Message, e error) error
  12. }
  14. PostReadRequestPlugin represents .
  15. type PostWriteResponsePlugin
  17. type PostWriteResponsePlugin interface {
  18.     PostWriteResponse(context.Context, *protocol.Message, *protocol.Message, error) error
  19. }
  21. PostWriteResponsePlugin represents .
  22. type PreReadRequestPlugin
  24. type PreReadRequestPlugin interface {
  25.     PreReadRequest(ctx context.Context) error
  26. }
  28. PreReadRequestPlugin represents .
  29. type PreWriteResponsePlugin
  31. type PreWriteResponsePlugin interface {
  32.     PreWriteResponse(context.Context, *protocol.Message) error
  33. }
  35. PreWriteResponsePlugin represents .

Client Plugin

go doc

  1. type PluginContainer
  3. type PluginContainer interface {
  4.     Add(plugin Plugin)
  5.     Remove(plugin Plugin)
  6.     All() []Plugin
  8.     DoPreCall(ctx context.Context, servicePath, serviceMethod string, args interface{}) error
  9.     DoPostCall(ctx context.Context, servicePath, serviceMethod string, args interface{}, reply interface{}, err error) error
  10. }
  12. PluginContainer represents a plugin container that defines all methods to manage plugins. And it also defines all extension points.
  13. type PostCallPlugin
  15. type PostCallPlugin interface {
  16.     DoPostCall(ctx context.Context, servicePath, serviceMethod string, args interface{}, reply interface{}, err error) error
  17. }
  19. PostCallPlugin is invoked after the client calls a server.
  20. type PreCallPlugin
  22. type PreCallPlugin interface {
  23.     DoPreCall(ctx context.Context, servicePath, serviceMethod string, args interface{}) error
  24. }
  26. PreCallPlugin is invoked before the client calls a server.

By smallnest updated 2018-12-04 11:47:26