nats

Documentation

Index

• type Client
  • func NewNATSClient(ctx context.Context, natsOptions ...nats.Option) (*Client, error)
  • func NewTestClient(t *testing.T, url string) *Client
  • func (c *Client) BindKVStore(kvName string) (nats.KeyValue, error)
  • func (c *Client) Close()
  • func (c *Client) JetStreamContext(opts ...nats.JSOpt) (nats.JetStreamContext, error)
  • func (c *Client) PendingForStream(consumer string, stream string) (int64, error)
  • func (c *Client) Subscribe(subject string, stream string, opts ...nats.SubOpt) (*nats.Subscription, error)
• type ClientPool
  • func NewClientPool(ctx context.Context, opts ...Option) (*ClientPool, error)
  • func (p *ClientPool) CloseAll()
  • func (p *ClientPool) NextAvailableClient() *Client
• type Option
  • func WithClientPoolSize(size int) Option
• type Options

Types

type Client

type Client struct {
	sync.Mutex
	// contains filtered or unexported fields
}

Client is a client for NATS server which be shared by multiple connections (reader, writer, kv, buffer management, etc.)

func NewNATSClient

func NewNATSClient(ctx context.Context, natsOptions ...nats.Option) (*Client, error)

NewNATSClient Create a new NATS client

func NewTestClient

func NewTestClient(t *testing.T, url string) *Client

NewTestClient creates a new NATS client for testing only use this for testing

func (*Client) BindKVStore

func (c *Client) BindKVStore(kvName string) (nats.KeyValue, error)

BindKVStore lookup and bind to an existing KeyValue store and return the KeyValue interface

func (*Client) Close

func (c *Client) Close()

Close closes the NATS client

func (*Client) JetStreamContext

func (c *Client) JetStreamContext(opts ...nats.JSOpt) (nats.JetStreamContext, error)

JetStreamContext returns a new JetStreamContext

func (*Client) PendingForStream

func (c *Client) PendingForStream(consumer string, stream string) (int64, error)

PendingForStream returns the number of pending messages for the given consumer and stream

func (*Client) Subscribe

func (c *Client) Subscribe(subject string, stream string, opts ...nats.SubOpt) (*nats.Subscription, error)

Subscribe returns a subscription for the given subject and stream

type ClientPool

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

ClientPool is a pool of NATS clients used on at the initial create connection phase.

func NewClientPool

func NewClientPool(ctx context.Context, opts ...Option) (*ClientPool, error)

NewClientPool returns a new pool of NATS clients of the given size

func (*ClientPool) CloseAll

func (p *ClientPool) CloseAll()

CloseAll closes all the clients in the pool

func (*ClientPool) NextAvailableClient

func (p *ClientPool) NextAvailableClient() *Client

NextAvailableClient returns the next available NATS client. This code need not be optimized because this is not in hot code path. It is only during connection creation/startup.

type Option

type Option func(*Options)

Option is a function on the options for a NATS client pool

func WithClientPoolSize

func WithClientPoolSize(size int) Option

WithClientPoolSize sets the size of the NATS client pool

type Options

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

Options for NATS client pool