nats

Documentation

Index

• func NewNats(log logger.Logger, name string, hosts string, credentials gnats.Option, ...) (*gnats.Conn, error)
• type EphemeralOptsFunc
  • func WithEphemeralAckWait(duration time.Duration) EphemeralOptsFunc
  • func WithEphemeralConsumerDescription(description string) EphemeralOptsFunc
  • func WithEphemeralContext(context context.Context) EphemeralOptsFunc
  • func WithEphemeralDelivery(policy nats.DeliverPolicy) EphemeralOptsFunc
  • func WithEphemeralDisableSubscriberLogging() EphemeralOptsFunc
  • func WithEphemeralMaxAckPending(max int) EphemeralOptsFunc
  • func WithEphemeralMaxDeliver(max int) EphemeralOptsFunc
  • func WithEphemeralMaxRequestBatch(max int) EphemeralOptsFunc
• type ExactlyOnceOptsFunc
  • func WithExactlyOnceByStartTimePolicy(start time.Time) ExactlyOnceOptsFunc
  • func WithExactlyOnceConsumerDescription(description string) ExactlyOnceOptsFunc
  • func WithExactlyOnceContext(context context.Context) ExactlyOnceOptsFunc
  • func WithExactlyOnceDelivery(policy nats.DeliverPolicy) ExactlyOnceOptsFunc
  • func WithExactlyOnceDisableSubscriberLogging() ExactlyOnceOptsFunc
  • func WithExactlyOnceMaxDeliver(max int) ExactlyOnceOptsFunc
  • func WithExactlyOnceReplicas(replicas int) ExactlyOnceOptsFunc
• type Handler
• type QueueOptsFunc
  • func WithQueueAckWait(max time.Duration) QueueOptsFunc
  • func WithQueueConsumerDescription(description string) QueueOptsFunc
  • func WithQueueContext(context context.Context) QueueOptsFunc
  • func WithQueueDelivery(policy nats.DeliverPolicy) QueueOptsFunc
  • func WithQueueDisableSubscriberLogging() QueueOptsFunc
  • func WithQueueMaxAckPending(max int) QueueOptsFunc
  • func WithQueueMaxDeliver(max int) QueueOptsFunc
  • func WithQueueMaxRequestBatch(max int) QueueOptsFunc
  • func WithQueueReplicas(replicas int) QueueOptsFunc
• type Subscriber
  • func NewEphemeralConsumer(logger logger.Logger, js nats.JetStreamContext, stream string, subject string, ...) (Subscriber, error)
  • func NewExactlyOnceConsumer(logger logger.Logger, js nats.JetStreamContext, stream string, durable string, ...) (Subscriber, error)
  • func NewQueueConsumer(logger logger.Logger, js nats.JetStreamContext, stream string, durable string, ...) (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 EphemeralOptsFunc

type EphemeralOptsFunc func(config *ephemeralConsumerConfig) error

func WithEphemeralAckWait

func WithEphemeralAckWait(duration time.Duration) EphemeralOptsFunc

WithEphemeralAckWait overrides the default ack wait of 30s

func WithEphemeralConsumerDescription

func WithEphemeralConsumerDescription(description string) EphemeralOptsFunc

WithEphemeralConsumerDescription set the consumer description

func WithEphemeralContext

func WithEphemeralContext(context context.Context) EphemeralOptsFunc

WithEphemeralContext set the internal context

func WithEphemeralDelivery

func WithEphemeralDelivery(policy nats.DeliverPolicy) EphemeralOptsFunc

WithEphemeralDelivery set the internal context

func WithEphemeralDisableSubscriberLogging

func WithEphemeralDisableSubscriberLogging() EphemeralOptsFunc

WithEphemeralDisableSubscriberLogging to turn off extra trace logging in the subscriber

func WithEphemeralMaxAckPending

func WithEphemeralMaxAckPending(max int) EphemeralOptsFunc

WithEphemeralMaxAckPending set the maximum ack pending value

func WithEphemeralMaxDeliver

func WithEphemeralMaxDeliver(max int) EphemeralOptsFunc

WithEphemeralMaxDeliver set the maximum deliver value

func WithEphemeralMaxRequestBatch

func WithEphemeralMaxRequestBatch(max int) EphemeralOptsFunc

WithEphemeralMaxRequestBatch set the maximum number of records to fetch

type ExactlyOnceOptsFunc

type ExactlyOnceOptsFunc func(config *exactlyOnceConsumerConfig) error

func WithExactlyOnceByStartTimePolicy

func WithExactlyOnceByStartTimePolicy(start time.Time) ExactlyOnceOptsFunc

func WithExactlyOnceConsumerDescription

func WithExactlyOnceConsumerDescription(description string) ExactlyOnceOptsFunc

WithExactlyOnceConsumerDescription set the consumer description

func WithExactlyOnceContext

func WithExactlyOnceContext(context context.Context) ExactlyOnceOptsFunc

WithExactlyOnceContext set the internal context

func WithExactlyOnceDelivery

func WithExactlyOnceDelivery(policy nats.DeliverPolicy) ExactlyOnceOptsFunc

WithExactlyOnceDelivery set the internal context

func WithExactlyOnceDisableSubscriberLogging

func WithExactlyOnceDisableSubscriberLogging() ExactlyOnceOptsFunc

WithExactlyOnceDisableSubscriberLogging to turn off extra trace logging in the subscriber

func WithExactlyOnceMaxDeliver

func WithExactlyOnceMaxDeliver(max int) ExactlyOnceOptsFunc

WithExactlyOnceMaxDeliver set the maximum deliver value

func WithExactlyOnceReplicas

func WithExactlyOnceReplicas(replicas int) ExactlyOnceOptsFunc

WithExactlyOnceReplicas set the number of replicas for the consumer

type Handler

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

type QueueOptsFunc

type QueueOptsFunc func(config *queueConsumerConfig) error

func WithQueueAckWait

func WithQueueAckWait(max time.Duration) QueueOptsFunc

WithQueueAckWait set the maximum ack wait duration value

func WithQueueConsumerDescription

func WithQueueConsumerDescription(description string) QueueOptsFunc

WithQueueConsumerDescription set the consumer description

func WithQueueContext

func WithQueueContext(context context.Context) QueueOptsFunc

WithQueueContext set the internal context

func WithQueueDelivery

func WithQueueDelivery(policy nats.DeliverPolicy) QueueOptsFunc

WithQueueDelivery set the internal context

func WithQueueDisableSubscriberLogging

func WithQueueDisableSubscriberLogging() QueueOptsFunc

WithQueueDisableSubscriberLogging to turn off extra trace logging in the subscriber

func WithQueueMaxAckPending

func WithQueueMaxAckPending(max int) QueueOptsFunc

WithQueueMaxAckPending set the maximum ack pending value

func WithQueueMaxDeliver

func WithQueueMaxDeliver(max int) QueueOptsFunc

WithQueueMaxDeliver set the maximum deliver value

func WithQueueMaxRequestBatch

func WithQueueMaxRequestBatch(max int) QueueOptsFunc

WithQueueMaxRequestBatch set the maximum number of records to fetch

func WithQueueReplicas

func WithQueueReplicas(replicas int) QueueOptsFunc

WithQueueReplicas set the number of replicas

type Subscriber

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

Subscriber represents a nats subscriber

func NewEphemeralConsumer

func NewEphemeralConsumer(logger logger.Logger, js nats.JetStreamContext, stream string, subject string, handler Handler, opts ...EphemeralOptsFunc) (Subscriber, error)

NewEphemeralConsumer will create (or reuse) an ephemeral consumer

func NewExactlyOnceConsumer

func NewExactlyOnceConsumer(logger logger.Logger, js nats.JetStreamContext, stream string, durable string, subject string, handler Handler, opts ...ExactlyOnceOptsFunc) (Subscriber, error)

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

func NewQueueConsumer

func NewQueueConsumer(logger logger.Logger, js nats.JetStreamContext, stream string, durable string, subject string, handler Handler, opts ...QueueOptsFunc) (Subscriber, error)

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