natstream

Documentation

Index

• type Option
  • func WithClientID(id string) Option
  • func WithClusterID(id string) Option
  • func WithContext(ctx context.Context) Option
  • func WithEncoder(encoder encoder.Encoder) Option
  • func WithErrorHandler(h nc.ErrorHandler) Option
  • func WithGroupName(name string) Option
  • func WithLogger(logger loggerInterface) Option
  • func WithNatsConn(nc *nats.Conn) Option
  • func WithNatsOptions(natsOpts ...nstream.Option) Option
  • func WithNatsURL(urlString string) Option
  • func WithPanicHandler(h nc.PanicHandler) Option
  • func WithTopics(topics ...string) Option
• type Options
• type Publisher
  • func MustNewPublisher(options ...Option) *Publisher
  • func NewPublisher(options ...Option) (*Publisher, error)
  • func (s *Publisher) Close() error
  • func (s *Publisher) Publish(ctx context.Context, messages ...any) (err error)
• type Subscriber
  • func MustNewSubscriber(options ...Option) *Subscriber
  • func NewSubscriber(options ...Option) (*Subscriber, error)
  • func (s *Subscriber) Close() error
  • func (s *Subscriber) Listen(ctx context.Context) error

Types

type Option

type Option func(opt *Options)

Option of the NATS subscriber or publisher

func WithClientID

func WithClientID(id string) Option

WithClientID puts the client ID value

func WithClusterID

func WithClusterID(id string) Option

WithClusterID puts the cluster ID value

func WithContext

func WithContext(ctx context.Context) Option

WithContext puts the client context value

func WithEncoder

func WithEncoder(encoder encoder.Encoder) Option

WithEncoder set the message encoder

func WithErrorHandler

func WithErrorHandler(h nc.ErrorHandler) Option

WithErrorHandler set handler of error processing

func WithGroupName

func WithGroupName(name string) Option

WithGroupName puts the name group of the subsciber or publisher

func WithLogger

func WithLogger(logger loggerInterface) Option

WithLogger provides logging interface

func WithNatsConn

func WithNatsConn(nc *nats.Conn) Option

WithNatsConn is an Option to set the underlying NATS connection to be used by a streaming connection object. When such option is set, closing the streaming connection does not close the provided NATS connection.

func WithNatsOptions

func WithNatsOptions(natsOpts ...nstream.Option) Option

WithNatsOptions provides options of the NATS module

func WithNatsURL

func WithNatsURL(urlString string) Option

WithNatsURL is an Option to set the URL the client should connect to. The url can contain username/password semantics. e.g. nats://derek:pass@localhost:4222 Comma separated arrays are also supported, e.g. urlA, urlB.

func WithPanicHandler

func WithPanicHandler(h nc.PanicHandler) Option

WithPanicHandler set handler of panic processing

func WithTopics

func WithTopics(topics ...string) Option

WithTopics will set the list of topics for publishing or subscribing

type Options

type Options struct {
	Ctx context.Context

	// Raw options from the "github.com/nats-io/stan.go" module
	NatsOptions []nstream.Option

	// NatsSubscriptions suboptions of subscriptions
	NatsSubscriptions []nstream.Subscription

	// Name of the subscription group
	GroupName string

	// Names of topics for subscribing or publishing
	Topics []string

	// ClusterID common for the group of services
	ClusterID string

	// Client ID unical for the service
	ClientID string

	// ErrorHandler of message processing
	ErrorHandler nc.ErrorHandler

	// PanicHandler process panic
	PanicHandler nc.PanicHandler

	// Message encoder interface
	Encoder encoder.Encoder

	// Logger of subscriber
	Logger loggerInterface
}

Options of the NATS wrapper

type Publisher

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

Publisher for NATS queue

func MustNewPublisher

func MustNewPublisher(options ...Option) *Publisher

MustNewPublisher of the NATS stream server

func NewPublisher

func NewPublisher(options ...Option) (*Publisher, error)

NewPublisher of the NATS stream server

func (*Publisher) Close

func (s *Publisher) Close() error

Close nats-stream client

func (*Publisher) Publish

func (s *Publisher) Publish(ctx context.Context, messages ...any) (err error)

Publish one or more messages to the pub-service

type Subscriber

type Subscriber struct {
	nc.ModelSubscriber
	// contains filtered or unexported fields
}

Subscriber for NATS queue

func MustNewSubscriber

func MustNewSubscriber(options ...Option) *Subscriber

MustNewSubscriber creates new subscriber object

func NewSubscriber

func NewSubscriber(options ...Option) (*Subscriber, error)

NewSubscriber creates new subscriber object

func (*Subscriber) Close

func (s *Subscriber) Close() error

Close nstream client

func (*Subscriber) Listen

func (s *Subscriber) Listen(ctx context.Context) error

Listen kafka consumer