plugins

Documentation

Index

• Constants
• Variables
• func NewErrCounfigNotFound(s any) error
• func NewErrDefaultServiceNotFound(t ServiceType) error
• func NewErrDisabled(target string) error
• func NewErrDisabledService(s Service) error
• func NewErrInvalid(target string) error
• func NewErrInvalidService(s Service) error
• func NewErrNotFound(target string) error
• func NewErrServiceNotFound(t ServiceType) error
• type Config
  • func NewConfig() Config
  • func NewConfigWith(conf config.Config) Config
• type ConfigBase
• type Manager
  • func NewManager() *Manager
  • func (mgr *Manager) DefaultService(t ServiceType) (Service, error)
  • func (mgr *Manager) EnabledServicesByType(t ServiceType) []Service
  • func (mgr *Manager) RegisterService(service Service)
  • func (mgr *Manager) ReloadServices(services []Service)
  • func (mgr *Manager) Services() []Service
  • func (mgr *Manager) ServicesByType(t ServiceType) []Service
  • func (mgr *Manager) Start() error
  • func (mgr Manager) Stop() error
  • func (mgr *Manager) String() string
• type Service
• type ServiceConfig
• type ServiceExtConfig
• type ServiceType
  • func ServiceTypes() []ServiceType
  • func (t ServiceType) IsExclusive() bool
  • func (t ServiceType) String() string
• type ServiceTypeConfig
• type ServiceTypeExtConfig

Constants

const (
	ConfigPlugins = "plugins"
	ConfigDefault = "default"
	ConfigEnabled = "enabled"
	ConfigPort    = "port"
)

const (
	// ExclusiveServiceType represents an exclusive service type.
	ExclusiveServiceType = 0x80
)

Variables

var ErrDisabled = errors.New("disabled")

var ErrInvalid = errors.New("invalid")

var ErrNotFound = errors.New("not found")

Functions

func NewErrCounfigNotFound

func NewErrCounfigNotFound(s any) error

func NewErrDefaultServiceNotFound

func NewErrDefaultServiceNotFound(t ServiceType) error

func NewErrDisabled

func NewErrDisabled(target string) error

func NewErrDisabledService

func NewErrDisabledService(s Service) error

func NewErrInvalid

func NewErrInvalid(target string) error

func NewErrInvalidService

func NewErrInvalidService(s Service) error

func NewErrNotFound

func NewErrNotFound(target string) error

func NewErrServiceNotFound

func NewErrServiceNotFound(t ServiceType) error

Types

type Config

type Config interface {
	ConfigBase
	ServiceTypeConfig
	ServiceTypeExtConfig
	ServiceConfig
	ServiceExtConfig
}

Config represents a plug-in configuration interface.

func NewConfig

func NewConfig() Config

func NewConfigWith

func NewConfigWith(conf config.Config) Config

type ConfigBase

type ConfigBase interface {
	config.Config
	// String returns a string representation of the configuration.
	SetConfig(c config.Config)
	// Object returns a raw configuration object.
	Object() config.Config
}

ConfigBase represents a basic configuration interface.

type Manager

type Manager struct {
	Config
	// contains filtered or unexported fields
}

Manager represents a plug-in manager.

func NewManager

func NewManager() *Manager

NewManager returns a plug-in manager instance.

func (*Manager) DefaultService

func (mgr *Manager) DefaultService(t ServiceType) (Service, error)

DefaultService returns the default plug-in service with the specified type.

func (*Manager) EnabledServicesByType

func (mgr *Manager) EnabledServicesByType(t ServiceType) []Service

EnabledServicesByType returns all enabled plug-in services with the specified type.

func (*Manager) RegisterService

func (mgr *Manager) RegisterService(service Service)

RegisterService adds a plug-in service.

func (*Manager) ReloadServices

func (mgr *Manager) ReloadServices(services []Service)

ReloadServices reloads all plug-in services.

func (*Manager) Services

func (mgr *Manager) Services() []Service

Services returns all registered plug-in services.

func (*Manager) ServicesByType

func (mgr *Manager) ServicesByType(t ServiceType) []Service

ServicesByType returns all registered plug-in services with the specified type.

func (*Manager) Start

func (mgr *Manager) Start() error

Start starts all plug-in services.

func (Manager) Stop

func (mgr Manager) Stop() error

Stop stops all plug-in services.

func (*Manager) String

func (mgr *Manager) String() string

String returns a string representation of the plug-in manager.

type Service

type Service interface {
	// SetConfig sets the specified config.
	SetConfig(config config.Config)
	// ServiceType returns the service type.
	ServiceType() ServiceType
	// ServiceName returns the service name.
	ServiceName() string
	// Start starts the service
	Start() error
	// Stop stops the service
	Stop() error
}

Service represents a plugin service.

type ServiceConfig

type ServiceConfig interface {
	// GetServiceConfig returns a value for the specified name in the service.
	GetServiceConfig(service Service, paths ...string) (any, error)
	// GetServiceConfigString returns a string value for the specified name in the service.
	GetServiceConfigString(service Service, paths ...string) (string, error)
	// GetServiceConfigInt returns an integer value for the specified name in the service.
	GetServiceConfigInt(service Service, paths ...string) (int, error)
	// GetServiceConfigBool returns a boolean value for the specified name in the service.
	GetServiceConfigBool(service Service, paths ...string) (bool, error)
}

ServiceConfig represents a configuration interface for service.

type ServiceExtConfig

type ServiceExtConfig interface {
	// IsServiceConfigEnabled returns true if the service is enabled.
	IsServiceConfigEnabled(service Service) bool
	// GetServiceConfigPort returns a port number for the service.
	GetServiceConfigPort(service Service) (int, error)
}

ServiceExtConfig represents an extension configuration interface for service.

type ServiceType

type ServiceType uint8

ServiceType represents a service type.

const (
	// SystemService represents a system service.
	SystemService ServiceType = 0x01
	// CoderKeyService represents a serializer service for key.
	CoderKeyService ServiceType = 0x02 | ExclusiveServiceType
	// CoderDocumentService represents a serializer service for document.
	CoderDocumentService ServiceType = 0x03 | ExclusiveServiceType
	// QueryService represents a query service.
	QueryService ServiceType = 0x04
	// StoreDocumentService represents a document store service.
	StoreDocumentService ServiceType = 0x05 | ExclusiveServiceType
	// StoreKvService represents a key-value store service.
	StoreKvService ServiceType = 0x06 | ExclusiveServiceType
	// StoreKvCacheService represents a key-value cache store service.
	StoreKvCacheService ServiceType = 0x07 | ExclusiveServiceType
	// CoordinatorService represents a coordinator service.
	CoordinatorService ServiceType = 0x08 | ExclusiveServiceType
	// TracingService represents a distributed tracing service.
	TracingService ServiceType = 0x09 | ExclusiveServiceType
	// MetricsService represents a metrics service.
	MetricsService ServiceType = 0x0A
	// AuthenticatorService represents an authenticator service.
	AuthenticatorService ServiceType = 0x0B
	// ExtendService represents an uncategorized service.
	ExtendService ServiceType = 0x0F
)

func ServiceTypes

func ServiceTypes() []ServiceType

ServiceTypes returns all service types.

func (ServiceType) IsExclusive

func (t ServiceType) IsExclusive() bool

IsExclusive returns true if the service type is exclusive.

func (ServiceType) String

func (t ServiceType) String() string

String returns a string representation of the service type.

type ServiceTypeConfig

type ServiceTypeConfig interface {
	// GetServiceTypeConfig returns a value for the specified name in the service type.
	GetServiceTypeConfig(serviceType ServiceType, item string) (any, error)
	// GetServiceTypeConfigString returns a string value for the specified name in the service type.
	GetServiceTypeConfigString(serviceType ServiceType, item string) (string, error)
	// GetServiceTypeConfigInt returns an integer value for the specified name in the service type.
	GetServiceTypeConfigInt(serviceType ServiceType, item string) (int, error)
	// GetServiceTypeConfigBool returns a boolean value for the specified name in the service type.
	GetServiceTypeConfigBool(serviceType ServiceType, item string) (bool, error)
}

ServiceTypeConfig represents a configuration interface for service type.

type ServiceTypeExtConfig

type ServiceTypeExtConfig interface {
	// IsServiceTypeConfigEnabled returns true if the service type is enabled.
	IsServiceTypeConfigEnabled(serviceType ServiceType) bool
	// GetServiceTypeConfigPort returns a port number for the service type.
	GetServiceTypeDefault(serviceType ServiceType) (string, error)
}

ServiceTypeExtConfig represents an extension configuration interface for service type.