jetstream

Documentation

Index

• type Iterator
  • func NewIterator(params IteratorParams) (*Iterator, error)
  • func (i *Iterator) Ack(sdkPosition sdk.Position) error
  • func (i *Iterator) HasNext() bool
  • func (i *Iterator) Next(ctx context.Context) (sdk.Record, error)
  • func (i *Iterator) Stop() (err error)
• type IteratorParams

Types

type Iterator

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

Iterator is a iterator for JetStream communication model. It receives message from NATS JetStream.

func NewIterator

func NewIterator(params IteratorParams) (*Iterator, error)

NewIterator creates new instance of the Iterator.

func (*Iterator) Ack

func (i *Iterator) Ack(sdkPosition sdk.Position) error

Ack acknowledges a message at the given position.

func (*Iterator) HasNext

func (i *Iterator) HasNext() bool

HasNext checks is the iterator has messages.

func (*Iterator) Next

func (i *Iterator) Next(ctx context.Context) (sdk.Record, error)

Next returns the next record from the underlying messages channel. It also appends messages to a unackMessages slice if the AckPolicy is not equal to AckNonePolicy.

func (*Iterator) Stop

func (i *Iterator) Stop() (err error)

Stop stops the Iterator, unsubscribes from a subject.

type IteratorParams

type IteratorParams struct {
	Conn           *nats.Conn
	BufferSize     int
	Durable        string
	DeliverSubject string
	Subject        string
	SDKPosition    sdk.Position
	DeliverPolicy  nats.DeliverPolicy
	AckPolicy      nats.AckPolicy
}

IteratorParams contains incoming params for the NewIterator function.