nats

Documentation

Overview

Package nats provides config and flags for connecting to NATS.

Index

• type Config
  • func DefaultConfig() *Config
  • func (c *Config) Connect(ctx context.Context) (*nats.Conn, error)
  • func (c *Config) Flags(prefix string, defaults *Config) *pflag.FlagSet
• type CredsConfig
  • func (f CredsConfig) Load(_ context.Context, fileReader FileReader) (nats.Option, error)
• type FileReader

Types

type Config

type Config struct {
	Servers      []string
	Name         string
	Username     string
	Password     string
	PasswordFile string
	Store        string
	Credentials  CredsConfig
	TLSConfig    *tls.Config
}

Config is the configuration for the NATS connection.

func DefaultConfig

func DefaultConfig() *Config

DefaultConfig returns the default configuration for the NATS connection.

func (*Config) Connect

func (c *Config) Connect(ctx context.Context) (*nats.Conn, error)

Connect opens a connection to NATS.

func (*Config) Flags

func (c *Config) Flags(prefix string, defaults *Config) *pflag.FlagSet

Flags returns a flagset that can be added to the command line.

type CredsConfig

type CredsConfig struct {
	CredsFile string
	JWTFile   string
	SeedFile  string
}

CredsConfig represents NATS credentials.

func (CredsConfig) Load

func (f CredsConfig) Load(_ context.Context, fileReader FileReader) (nats.Option, error)

Load loads the NATS credentials. If fileReader is nil, this uses ioutil.ReadFile.

type FileReader

type FileReader interface {
	ReadFile(filename string) ([]byte, error)
}

FileReader reads a file and returns its bytes.