natsclient

Documentation

Index

• Constants
• Variables
• func CollectConsumerMetric(subject, action string, err error, duration float64)
• func CollectPublisherMetrics(subject string, err error, duration float64)
• type Consumer
  • func NewConsumer[T any](ctx context.Context, conn *nats.Conn, group, subject string, ...) (*Consumer[T], error)
  • func (c *Consumer[T]) Close() error
• type ConsumerOpt
  • func WithAckPolicy(policy nats.AckPolicy) ConsumerOpt
  • func WithAckWait(wait time.Duration) ConsumerOpt
  • func WithDeliverPolicy(policy nats.DeliverPolicy) ConsumerOpt
  • func WithMaxAckPending(count int) ConsumerOpt
  • func WithRateLimit(limit uint64) ConsumerOpt
• type Producer
  • func NewProducer(conn *nats.Conn, subject string) (*Producer, error)
  • func (p *Producer) PublishData(ctx context.Context, data []byte) error
  • func (p *Producer) PublishJSON(ctx context.Context, v any) error
• type Publisher
  • func NewPublisher(nc *nats.Conn) (*Publisher, error)
  • func (p *Publisher) PublishJSON(ctx context.Context, subject string, obj any) error

Constants

const (
	KiB = 8 * 1024
	MiB = KiB * 1024
	GiB = MiB * 1024
)

const (
	StreamDefaultMaxAge = time.Hour * 48
)

Variables

var (
	ConsumerMetrics = promauto.NewHistogramVec(
		prometheus.HistogramOpts{
			Namespace: "nats",
			Subsystem: "consumer",
			Name:      "duration_consume",
			Help:      "Consume duration",
			Buckets:   []float64{.005, .01, .025, .05, .075, .1, .15, .2, .25, .5, 1, 2.5, 5, 10, 15, 30},
		},
		[]string{"subject", "action", "error"},
	)

	PublisherMetrics = promauto.NewHistogramVec(
		prometheus.HistogramOpts{
			Namespace: "nats",
			Subsystem: "publisher",
			Name:      "duration_publish",
			Help:      "Publish duration",
			Buckets:   []float64{.005, .01, .025, .05, .075, .1, .15, .2, .25, .5, 1, 2.5, 5, 10, 15, 30},
		},
		[]string{"subject", "error"},
	)
)

var (
	ErrSubjectRequired = errors.New("subject is required")
	ErrInvalidChars    = errors.New("subject contains spaces")
)

var ErrGroupRequired = errors.New("group is required")

Functions

func CollectConsumerMetric

func CollectConsumerMetric(subject, action string, err error, duration float64)

func CollectPublisherMetrics

func CollectPublisherMetrics(subject string, err error, duration float64)

Types

type Consumer

type Consumer[T any] struct {
	// contains filtered or unexported fields
}

func NewConsumer

func NewConsumer[T any](ctx context.Context, conn *nats.Conn, group, subject string, h events.Handler[T], opts ...ConsumerOpt) (*Consumer[T], error)

NewConsumer creates nats QueueSubscribe with custom handler Group must be the name of service or package: core, feed, etc. It's allow handle messages in few consumers.

func (*Consumer[T]) Close

func (c *Consumer[T]) Close() error

type ConsumerOpt

type ConsumerOpt func(*nats.ConsumerConfig)

func WithAckPolicy

func WithAckPolicy(policy nats.AckPolicy) ConsumerOpt

func WithAckWait

func WithAckWait(wait time.Duration) ConsumerOpt

func WithDeliverPolicy

func WithDeliverPolicy(policy nats.DeliverPolicy) ConsumerOpt

func WithMaxAckPending

func WithMaxAckPending(count int) ConsumerOpt

func WithRateLimit

func WithRateLimit(limit uint64) ConsumerOpt

type Producer

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

func NewProducer

func NewProducer(conn *nats.Conn, subject string) (*Producer, error)

NewProducer ... fixme: add description

func (*Producer) PublishData

func (p *Producer) PublishData(ctx context.Context, data []byte) error

func (*Producer) PublishJSON

func (p *Producer) PublishJSON(ctx context.Context, v any) error

type Publisher

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

func NewPublisher

func NewPublisher(nc *nats.Conn) (*Publisher, error)

func (*Publisher) PublishJSON

func (p *Publisher) PublishJSON(ctx context.Context, subject string, obj any) error