nats

Documentation

Index

• type BasicAuthOptions
• type Client
  • func New(nodes []string, bucket string, opts ...Option) (*Client, error)
  • func (c *Client) Close()
  • func (c *Client) GetValues(keys []string) (map[string]string, error)
  • func (c *Client) WatchPrefix(ctx context.Context, prefix string, opts ...easykv.WatchOption) (uint64, error)
• type Option
  • func WithBasicAuth(b BasicAuthOptions) Option
  • func WithCredentials(c string) Option
  • func WithToken(t string) Option
• type Options

Types

type BasicAuthOptions

type BasicAuthOptions struct {
	Username string
	Password string
}

BasicAuthOptions contains options regarding to basic authentication.

type Client

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

Client provides a shell for the env client

func New

func New(nodes []string, bucket string, opts ...Option) (*Client, error)

New returns a new client

func (*Client) Close

func (c *Client) Close()

Close is only meant to fulfill the easykv.ReadWatcher interface. Does nothing.

func (*Client) GetValues

func (c *Client) GetValues(keys []string) (map[string]string, error)

GetValues is used to lookup all keys with a prefix. Several prefixes can be specified in the keys array.

func (*Client) WatchPrefix

func (c *Client) WatchPrefix(ctx context.Context, prefix string, opts ...easykv.WatchOption) (uint64, error)

WatchPrefix

type Option

type Option func(*Options)

Option configures the nats client.

func WithBasicAuth

func WithBasicAuth(b BasicAuthOptions) Option

WithBasicAuth enables the basic authentication and sets the username and password.

func WithCredentials

func WithCredentials(c string) Option

WithCredentials enables the NATS 2.0 and NATS NGS compatible user credentials and sets the path to the credentials file

func WithToken

func WithToken(t string) Option

WithToken enables the token authentication and sets the token.

type Options

type Options struct {
	Nodes []string
	Auth  BasicAuthOptions
	Token string
	Creds string
}

Options contains all values that are needed to connect to nats.