nats

Documentation

Index

• func NewNats(log logger.Logger, name string, hosts string, credentials gnats.Option, ...) (*gnats.Conn, error)
• type EphemeralConsumerConfig
• type ExactlyOnceConsumerConfig
• type Handler
• type QueueConsumerConfig
• type Subscriber
  • func NewEphemeralConsumer(ctx context.Context, logger logger.Logger, js nats.JetStreamContext, ...) (Subscriber, error)
  • func NewEphemeralConsumerDeliverAll(ctx context.Context, logger logger.Logger, js nats.JetStreamContext, ...) (Subscriber, error)
  • func NewEphemeralConsumerWithConfig(config EphemeralConsumerConfig) (Subscriber, error)
  • func NewExactlyOnceConsumer(ctx context.Context, logger logger.Logger, js nats.JetStreamContext, ...) (Subscriber, error)
  • func NewExactlyOnceConsumerWithConfig(config ExactlyOnceConsumerConfig) (Subscriber, error)
  • func NewQueueConsumer(ctx context.Context, logger logger.Logger, js nats.JetStreamContext, ...) (Subscriber, error)
  • func NewQueueConsumerWithConfig(config QueueConsumerConfig) (Subscriber, error)

Functions

func NewNats

func NewNats(log logger.Logger, name string, hosts string, credentials gnats.Option, opts ...gnats.Option) (*gnats.Conn, error)

NewNats will return a new nats connections

Types

type EphemeralConsumerConfig

type EphemeralConsumerConfig struct {
	Context             context.Context
	Logger              logger.Logger
	JetStream           nats.JetStreamContext
	StreamName          string
	ConsumerDescription string
	FilterSubject       string
	Handler             Handler
	DeliverPolicy       nats.DeliverPolicy
	Deliver             nats.SubOpt
}

type ExactlyOnceConsumerConfig

type ExactlyOnceConsumerConfig struct {
	Context             context.Context
	Logger              logger.Logger
	JetStream           nats.JetStreamContext
	StreamName          string
	DurableName         string
	ConsumerDescription string
	FilterSubject       string
	Handler             Handler
	DeliverPolicy       nats.DeliverPolicy
	Deliver             nats.SubOpt
	MaxAckPending       int
}

type Handler

type Handler func(ctx context.Context, payload []byte, msg *nats.Msg) error

type QueueConsumerConfig

type QueueConsumerConfig struct {
	Context             context.Context
	Logger              logger.Logger
	JetStream           nats.JetStreamContext
	StreamName          string
	DurableName         string
	ConsumerDescription string
	FilterSubject       string
	Handler             Handler
	DeliverPolicy       nats.DeliverPolicy
	Deliver             nats.SubOpt
}

type Subscriber

type Subscriber interface {
	// Close the subscriber and stop delivery
	Close() error
}

Subscriber represents a nats subscriber

func NewEphemeralConsumer

func NewEphemeralConsumer(ctx context.Context, logger logger.Logger, js nats.JetStreamContext, stream string, description string, subject string, handler Handler) (Subscriber, error)

NewEphemeralConsumer will create (or reuse) an ephemeral consumer with default config

func NewEphemeralConsumerDeliverAll

func NewEphemeralConsumerDeliverAll(ctx context.Context, logger logger.Logger, js nats.JetStreamContext, stream string, description string, subject string, handler Handler) (Subscriber, error)

NewEphemeralConsumerDeliverAll will create (or reuse) an ephemeral consumer with default config which will deliver all messages (not just new ones)

func NewEphemeralConsumerWithConfig

func NewEphemeralConsumerWithConfig(config EphemeralConsumerConfig) (Subscriber, error)

NewEphemeralConsumerWithConfig will create (or reuse) ephemeral consumer

func NewExactlyOnceConsumer

func NewExactlyOnceConsumer(ctx context.Context, logger logger.Logger, js nats.JetStreamContext, stream string, durable string, description string, subject string, handler Handler) (Subscriber, error)

NewExactlyOnceConsumer will create (or reuse) an exactly once durable consumer

func NewExactlyOnceConsumerWithConfig

func NewExactlyOnceConsumerWithConfig(config ExactlyOnceConsumerConfig) (Subscriber, error)

NewExactlyOnceConsumer will create (or reuse) an exactly once durable consumer

func NewQueueConsumer

func NewQueueConsumer(ctx context.Context, logger logger.Logger, js nats.JetStreamContext, stream string, durable string, description string, subject string, handler Handler) (Subscriber, error)

NewQueueConsumer will create (or reuse) a queue consumer with default config

func NewQueueConsumerWithConfig

func NewQueueConsumerWithConfig(config QueueConsumerConfig) (Subscriber, error)

NewQueueConsumerWithConfig will create (or reuse) queue consumer