nats

Documentation

Overview

Package nats provide a message broker using NATS.

Index

• Variables
• type Config
• type Nats
  • func New(addrs string, opts ...Option) (*Nats, error)
  • func (n *Nats) HealthCheck() health.CheckFunc
  • func (n *Nats) Publish(topic string, m *broker.Message, opts ...broker.PublishOption) error
  • func (n *Nats) Subscribe(topic string, h broker.Handler, opts ...broker.SubscribeOption) (broker.Subscriber, error)
• type Option
  • func Encoder(encoder broker.Encoder) Option
  • func FromEnv(readOpts ...config.ReadOption) Option
  • func Options(opts ...nats.Option) Option

Variables

var (
	// ErrMissingEncoder report the encoder is missing.
	ErrMissingEncoder = errors.New("nats: missing encoder")
)

Types

type Config

type Config struct {
	Addrs    string        `envconfig:"NATS_ADDRS" default:"nats:4222"`
	Encoder  string        `envconfig:"NATS_ENCODER" default:"proto"`
	Timeout  time.Duration `envconfig:"NATS_TIMEOUT" default:"10s"`
	Username string        `envconfig:"NATS_USERNAME"`
	Password string        `envconfig:"NATS_PASSWORD"`
}

Config hold common NATS configurations.

type Nats

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

Nats is an implementation of broker.Broker using NATS.

func New

func New(addrs string, opts ...Option) (*Nats, error)

New return a new NATs message broker.

func (*Nats) HealthCheck

func (n *Nats) HealthCheck() health.CheckFunc

HealthCheck return a health check func.

func (*Nats) Publish

func (n *Nats) Publish(topic string, m *broker.Message, opts ...broker.PublishOption) error

Publish implements broker.Broker interface.

func (*Nats) Subscribe

func (n *Nats) Subscribe(topic string, h broker.Handler, opts ...broker.SubscribeOption) (broker.Subscriber, error)

Subscribe implements broker.Broker interface.

type Option

type Option func(*Nats)

Option is an optional configuration.

func Encoder

func Encoder(encoder broker.Encoder) Option

Encoder is an option to provide a custom encoder.

func FromEnv

func FromEnv(readOpts ...config.ReadOption) Option

FromEnv is an option to load common configuration from environment variables.

func Options

func Options(opts ...nats.Option) Option

Options is an option to provide additional nats.Option.