broker

Documentation

Index

• Variables
• type Broker
• type Publishable

Variables

var ErrBrokerClosed = errors.New("broker: broker closed")

ErrBrokerClosed indicates that the broker was closed by a call to Close.

Types

type Broker

type Broker interface {
	// Publish publishes a Publishable message on the broker.
	Publish(ctx context.Context, message Publishable) error
	// StartConsumer consumes messages on a broker. This method is blocking and
	// will always return with ErrBrokerClosed after calls to Close.
	StartConsumer(handlers map[string]func([]byte) error) error
	// Close closes the broker.
	Close() error
}

Broker is capable of publishing and consuming Publishable messages.

type Publishable

type Publishable interface {
	Type() string
	Marshal() ([]byte, error)
	Unmarshal([]byte) error
}

Publishable represents an enty capable of being published and consumed by a Broker.