consumer

Documentation

Overview

Package consumer defines functions for consuming messages.

Index

• type Consumer
• type Error
• type FirstToLastConsumer
  • func NewFirstToLastConsumer(consumerOffsetManager thead.Manager, ...) *FirstToLastConsumer
  • func (f *FirstToLastConsumer) Consume(globalCtx context.Context, handler MessageHandler) error
• type FirstToLastConsumerConfig
• type MessageHandler
• type MessageHandlerFunc
  • func (m MessageHandlerFunc) Handle(ctx context.Context, message storage.ProtoDecodable) error

Types

type Consumer

type Consumer interface {
	Consume(globalCtx context.Context, handler MessageHandler) error
}

Consumer defines an interface for blocking action for listening for incoming events and invoking handler on each of them when Consumer returns, it is always one of Error defined values wrapped

type Error

type Error error

var ErrContextDone Error = errors.New("context is done")

type FirstToLastConsumer

type FirstToLastConsumer struct {
	// contains filtered or unexported fields
}

func NewFirstToLastConsumer

func NewFirstToLastConsumer(consumerOffsetManager thead.Manager, commitReader, messageReader storage.MessageReader, config FirstToLastConsumerConfig,
	ipnsResolver ipns.Resolver) *FirstToLastConsumer

func (*FirstToLastConsumer) Consume

func (f *FirstToLastConsumer) Consume(globalCtx context.Context, handler MessageHandler) error

type FirstToLastConsumerConfig

type FirstToLastConsumerConfig struct {
	PollInterval time.Duration
	PollTimeout  time.Duration
	IPNSAddr     string
}

type MessageHandler

type MessageHandler interface {
	Handle(ctx context.Context, message storage.ProtoDecodable) error
}

MessageHandler is called to handle message found by Consumer. Handle on multiple messages can be called concurrently.

type MessageHandlerFunc

type MessageHandlerFunc func(ctx context.Context, message storage.ProtoDecodable) error

MessageHandlerFunc is a function implementing MessageHandler interface

func (MessageHandlerFunc) Handle

func (m MessageHandlerFunc) Handle(ctx context.Context, message storage.ProtoDecodable) error

Handle calls MessageHandlerFunc