nats

Documentation

Index

• Variables
• type Config
  • func LoadConfigFromEnv() Config
  • func (conf Config) GetEncoder() broker.Encoder
  • func (conf Config) Options() []nats.Option
• type Nats
  • func New(conf Config, additionalOpts ...nats.Option) (*Nats, error)
  • func NewWithEncoder(addrs string, enc broker.Encoder, opts ...nats.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)

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 NATS configurations.

func LoadConfigFromEnv

func LoadConfigFromEnv() Config

LoadConfigFromEnv load NATS config from environement variables.

func (Config) GetEncoder

func (conf Config) GetEncoder() broker.Encoder

GetEncoder return the configured encoder.

func (Config) Options

func (conf Config) Options() []nats.Option

Options return list of nats.Option.

type Nats

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

Nats is an implementation of broker.Broker.

func New

func New(conf Config, additionalOpts ...nats.Option) (*Nats, error)

New Nats with a configuration and additional options if needed.

func NewWithEncoder

func NewWithEncoder(addrs string, enc broker.Encoder, opts ...nats.Option) (*Nats, error)

NewWithEncoder return a new NATS client with the given encoder.

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.