streamclient

Documentation

Index

• Constants
• Variables
• func NewConsumer(options ...streamconfig.Option) (stream.Consumer, error)
• func NewProducer(options ...streamconfig.Option) (stream.Producer, error)
• func TestMessageFromConsumer(tb testing.TB, consumer stream.Consumer) stream.Message
• type Type
  • func (t Type) String() string

Constants

const (
	// Unknown represents an unknown streamclient implementation.
	Unknown Type = "unknown"

	// Inmem represents the in-memory streamclient implementation.
	Inmem = "inmem"

	// Kafka represents the Kafka streamclient implementation.
	Kafka = "kafka"

	// Standardstream represents the Standardstream streamclient implementation.
	Standardstream = "standardstream"
)

Variables

var ErrUnknownConsumerClient = errors.New("unable to determine required consumer streamclient")

ErrUnknownConsumerClient is returned when the desired stream client cannot be inferred from the environment context.

var ErrUnknownProducerClient = errors.New("unable to determine required producer streamclient")

ErrUnknownProducerClient is returned when the desired stream client cannot be inferred from the environment context.

Functions

func NewConsumer

func NewConsumer(options ...streamconfig.Option) (stream.Consumer, error)

NewConsumer returns a new streamclient consumer, based on the context from which this function is called.

func NewProducer

func NewProducer(options ...streamconfig.Option) (stream.Producer, error)

NewProducer returns a new streamclient producer, based on the context from which this function is called.

func TestMessageFromConsumer

func TestMessageFromConsumer(tb testing.TB, consumer stream.Consumer) stream.Message

TestMessageFromConsumer returns a single message, consumed from the provided consumer. It has a built-in timeout mechanism to prevent the test from getting stuck.

Types

type Type

type Type string

Type represents the streamclient implementation type.

func (Type) String

func (t Type) String() string