limiter

Documentation

Index

• type Config
• type Limiter
  • func (l *Limiter) OnMessage(m *utils.Message, done utils.Done)
  • func (l *Limiter) Spawn(id int) utils.Composer
  • func (l *Limiter) Workers() int

Types

type Config

type Config struct {
	MessageLimit uint64
	BytesLimit   uint64
	Burst        uint64
}

Config stores the config for a Limiter

type Limiter

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

Limiter is a component that blocks the pipeline to ensure a maximum number of messages are being processed in a time. You may spawn ONLY ONE worker

func (*Limiter) OnMessage

func (l *Limiter) OnMessage(m *utils.Message, done utils.Done)

OnMessage will block the pipeline when the message rate is too high

func (*Limiter) Spawn

func (l *Limiter) Spawn(id int) utils.Composer

Spawn initializes the limiter

func (*Limiter) Workers

func (l *Limiter) Workers() int

Workers returns 1 because it should be only one instance of this component