stream

Documentation

Index

• type Config
  • func (c *Config) Condition() (condition.Condition, error)
  • func (c *Config) Decode(v any) error
  • func (c *Config) UnmarshalJSON(data []byte) (err error)
  • func (c *Config) Validate() error
• type Option
  • func WithCondition(cond condition.Condition) Option
  • func WithConfig(conf *Config) Option
  • func WithDebug(debug bool) Option
  • func WithMetrics(metrics metrics.MetricList) Option
  • func WithName(name string) Option
  • func WithObjectConfig(obj any) Option
  • func WithRawConfig(raw json.RawMessage) Option
  • func WithWhere(where string) Option
• type Streamer

Types

type Config

type Config struct {
	Name      string
	Debug     bool
	Store     string
	Source    string
	Metrics   metrics.MetricList
	Raw       json.RawMessage
	Where     string
	WhereCond condition.Condition
}

Config of the stream

func (*Config) Condition

func (c *Config) Condition() (condition.Condition, error)

Condition of the stream

func (*Config) Decode

func (c *Config) Decode(v any) error

Decode raw data to the target object

func (*Config) UnmarshalJSON

func (c *Config) UnmarshalJSON(data []byte) (err error)

UnmarshalJSON data

func (*Config) Validate

func (c *Config) Validate() error

Validate config object

type Option

type Option func(cnf *Config)

Option of the stream

func WithCondition

func WithCondition(cond condition.Condition) Option

WithCondition condition

func WithConfig

func WithConfig(conf *Config) Option

WithConfig custom

func WithDebug

func WithDebug(debug bool) Option

WithDebug mode

func WithMetrics

func WithMetrics(metrics metrics.MetricList) Option

WithMetrics of the stream

func WithName

func WithName(name string) Option

WithName of the stream

func WithObjectConfig

func WithObjectConfig(obj any) Option

WithObjectConfig converts Object to JSON storage config

func WithRawConfig

func WithRawConfig(raw json.RawMessage) Option

WithRawConfig storage config

func WithWhere

func WithWhere(where string) Option

WithWhere condition

type Streamer

type Streamer interface {
	// Close extension
	io.Closer

	// ID returns unical stream identificator
	ID() string

	// Put message to the stream to process information
	Put(ctx context.Context, msg message.Message) error

	// Check if message suits for the stream
	Check(ctx context.Context, msg message.Message) bool

	// Run processing loop
	Run(ctx context.Context) error
}

Streamer interface of data processing describes basic methods of data pipeline