biz

Documentation

Index

• func NewFilterChain(settings *config.AppSettings) (filter.Filter, error)
• type Emitter
  • func NewEmitter(f filter.Filter, lim Limiter) *Emitter
  • func (e *Emitter) Close()
  • func (e *Emitter) CopyMulty(src PluginReader, writers ...PluginWriter) error
  • func (e *Emitter) Start(plugins *InOutPlugins)
• type InOutPlugins
  • func NewPlugins(settings *config.AppSettings) *InOutPlugins
  • func (plugins *InOutPlugins) String() string
• type Limiter
  • func NewRateLimit(settings *config.AppSettings) Limiter
• type PluginReader
• type PluginWriter

Functions

func NewFilterChain

func NewFilterChain(settings *config.AppSettings) (filter.Filter, error)

Types

type Emitter

type Emitter struct {
	sync.WaitGroup
	// contains filtered or unexported fields
}

Emitter represents an abject to manage plugins communication

func NewEmitter

func NewEmitter(f filter.Filter, lim Limiter) *Emitter

NewEmitter creates and initializes new Emitter object.

func (*Emitter) Close

func (e *Emitter) Close()

Close closes all the goroutine and waits for it to finish.

func (*Emitter) CopyMulty

func (e *Emitter) CopyMulty(src PluginReader, writers ...PluginWriter) error

CopyMulty copies from 1 reader to multiple writers

func (*Emitter) Start

func (e *Emitter) Start(plugins *InOutPlugins)

Start initialize loop for sending data from inputs to outputs

type InOutPlugins

type InOutPlugins struct {
	Inputs  []PluginReader
	Outputs []PluginWriter
	All     []interface{}
}

InOutPlugins struct for holding references to plugins

func NewPlugins

func NewPlugins(settings *config.AppSettings) *InOutPlugins

NewPlugins specify and initialize all available plugins

func (*InOutPlugins) String

func (plugins *InOutPlugins) String() string

type Limiter

type Limiter interface {
	Allow() bool
}

func NewRateLimit

func NewRateLimit(settings *config.AppSettings) Limiter

type PluginReader

type PluginReader interface {
	io.Closer
	Read() (msg *protocol.Message, err error)
}

PluginReader is an interface for input plugins

type PluginWriter

type PluginWriter interface {
	io.Closer
	Write(msg *protocol.Message) (err error)
}

PluginWriter is an interface for output plugins