ticker

Documentation

Overview

Package ticker offers an input carrier for the meander flow framework.

Index

• type Carrier
  • func New(ctx context.Context, logger journal.Logger, config *Config) (*Carrier, error)
  • func (c *Carrier) AcknowledgeMessage(m *flow.MessageContext, mErr error) error
  • func (c *Carrier) InternalError(m *flow.MessageContext, mErr error) error
  • func (c *Carrier) SetupInput(inChan chan *flow.MessageContext) error
• type Config

Types

type Carrier

type Carrier struct {
	Context  context.Context
	Logger   journal.Logger
	Interval time.Duration
}

Carrier defines the ticker carrier.

func New

func New(ctx context.Context, logger journal.Logger, config *Config) (*Carrier, error)

New initialises a new ticker carrier.

func (*Carrier) AcknowledgeMessage

func (c *Carrier) AcknowledgeMessage(m *flow.MessageContext, mErr error) error

AcknowledgeMessage is not relevant for this carrier.

func (*Carrier) InternalError

func (c *Carrier) InternalError(m *flow.MessageContext, mErr error) error

InternalError is not relevant for this carrier.

func (*Carrier) SetupInput

func (c *Carrier) SetupInput(inChan chan *flow.MessageContext) error

SetupInput creates a ticker and writes to inChan on every tick.

type Config

type Config struct {
	// Interval -- The interval of the ticker.
	Interval time.Duration
}