component

Documentation

Index

• type Builder
• type Component
• type ComponentFunc
  • func (f ComponentFunc) ShouldBeLeader() bool
  • func (f ComponentFunc) Start(stop <-chan struct{}) error
• type Manager

Types

type Builder

type Builder interface {
	WithComponentManager(Manager) Builder
	WithMetrics(metric.Metrics) Builder
	Build() Component
}

Component builder, build component with injecting govern plugin

type Component

type Component interface {
	// Start blocks until the channel is closed or an error occurs.
	// The component will stop running when the channel is closed.
	Start(<-chan struct{}) error

	ShouldBeLeader() bool
}

type ComponentFunc

type ComponentFunc func(<-chan struct{}) error

func (ComponentFunc) ShouldBeLeader

func (f ComponentFunc) ShouldBeLeader() bool

func (ComponentFunc) Start

func (f ComponentFunc) Start(stop <-chan struct{}) error

type Manager

type Manager interface {
	Component
	AddComponent(...Component) error
}

Component manager, aggregate multiple components to one