plugin

Documentation

Index

• func WithContext(ctx context.Context, base PluginBase) context.Context
• type OptionFunc
  • func Context(ctx context.Context) OptionFunc
  • func ID(id string) OptionFunc
  • func Metadata(md map[string]string) OptionFunc
  • func Monitor(enable bool) OptionFunc
  • func Name(name string) OptionFunc
  • func RegistrarTimeout(t time.Duration) OptionFunc
  • func Registrars(r register.Registrar) OptionFunc
  • func Signal(sigs ...os.Signal) OptionFunc
  • func Version(version string) OptionFunc
• type PluginBase
  • func NewBase(conf *gofkConfs.PluginConfig, opts ...OptionFunc) PluginBase
• type PluginItem

Functions

func WithContext

func WithContext(ctx context.Context, base PluginBase) context.Context

WithContext returns a new Context that carries value.

Types

type OptionFunc

type OptionFunc func(o *pluginOptions)

func Context

func Context(ctx context.Context) OptionFunc

Context with service context.

func ID

func ID(id string) OptionFunc

ID with service id.

func Metadata

func Metadata(md map[string]string) OptionFunc

Metadata with service metadata.

func Monitor

func Monitor(enable bool) OptionFunc

TODO Monitor未实现

func Name

func Name(name string) OptionFunc

Name with service name.

func RegistrarTimeout

func RegistrarTimeout(t time.Duration) OptionFunc

RegistrarTimeout with registrar timeout.

func Registrars

func Registrars(r register.Registrar) OptionFunc

Registrars with service registry.

func Signal

func Signal(sigs ...os.Signal) OptionFunc

Signal with exit signals.

func Version

func Version(version string) OptionFunc

Version with service version.

type PluginBase

type PluginBase interface {
	ID() string
	Name() string
	Version() string
	Metadata() map[string]string

	Add(items ...PluginItem)
	Run()
	Stop() error
	GetOpts() *pluginOptions
}

func NewBase

func NewBase(conf *gofkConfs.PluginConfig, opts ...OptionFunc) PluginBase

type PluginItem

type PluginItem interface {
	Start() error //开始插件
	Exit()        //退出插件
	Enable() bool //插件开关
	Name() string //服务名称
}