eventbus

Documentation

Overview

Package eventbus provides access to an eventbus where governor events can be published. Currently, the only concrete implementation is a NATS client.

Index

• Variables
• type Client
  • func NewClient(opts ...Option) *Client
  • func (c *Client) Publish(ctx context.Context, sub string, event *events.Event) error
  • func (c *Client) Shutdown() error
• type Option
  • func WithLogger(l *zap.Logger) Option
  • func WithNATSConn(nc conn) Option
  • func WithNATSPrefix(p string) Option

Variables

var ErrEmptyEvent = errors.New("event is empty")

ErrEmptyEvent is returned when an empty event is passed

Types

type Client

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

Client is an event bus client with some configuration

func NewClient

func NewClient(opts ...Option) *Client

NewClient configures and establishes a new event bus client connection

func (*Client) Publish

func (c *Client) Publish(ctx context.Context, sub string, event *events.Event) error

Publish an event on the event bus

func (*Client) Shutdown

func (c *Client) Shutdown() error

Shutdown drains the event bus and closes the connections

type Option

type Option func(c *Client)

Option is a functional configuration option for governor eventing

func WithLogger

func WithLogger(l *zap.Logger) Option

WithLogger sets the client logger

func WithNATSConn

func WithNATSConn(nc conn) Option

WithNATSConn sets the nats connection

func WithNATSPrefix

func WithNATSPrefix(p string) Option

WithNATSPrefix sets the nats subscription prefix