Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

streamhelper

package

Go to main page

Versions in this module

v2

v2.1.0

Jul 27, 2022

v2.0.2

Jun 15, 2022

v2.0.1

Jun 10, 2022

Changes in this version

+ var ErrStreamConsumerAlreadyListened = errors.New("stream already listened")

+ var ErrStreamConsumerNotListeningYet = errors.New("stream not listening yet")

+ var ErrStreamNeedToPointOutGroups = errors.New("stream need to point out groups")

+ func SerializeWithJSON() optparams.Option[Options]

+ func SerializeWithMsgpack() optparams.Option[Options]

+ func WithAutocreate() optparams.Option[createGroupOpt]

+ func WithBlockTime(d time.Duration) optparams.Option[Options]

+ func WithClientID(clientID string) optparams.Option[Options]

+ func WithConsumerAckMode(ack AckModeType) optparams.Option[Options]

+ func WithConsumerDefaultStartAt(t time.Time) optparams.Option[Options]

+ func WithConsumerDefaultStartEarliest() optparams.Option[Options]

+ func WithConsumerDefaultStartLatest() optparams.Option[Options]

+ func WithConsumerDefaultStartPosition(flag string) optparams.Option[Options]

+ func WithConsumerGroupName(groupname string) optparams.Option[Options]

+ func WithConsumerRecvBatchSize(size int64) optparams.Option[Options]

+ func WithProducerDefaultMaxLen(n int64) optparams.Option[Options]

+ func WithProducerDefaultStrict() optparams.Option[Options]

+ func WithStartAtID(id string) optparams.Option[createGroupOpt]

+ func WithStartEarliest() optparams.Option[createGroupOpt]

+ func WithStartLatest() optparams.Option[createGroupOpt]

+ func WithStrict() optparams.Option[trimOpt]

+ func WithUUIDSnowflake() optparams.Option[Options]

+ func WithUUIDSonyflake() optparams.Option[Options]

+ func WithUUIDv4() optparams.Option[Options]

+ type AckModeType uint8

+ const AckModeAckWhenDone

+ const AckModeAckWhenGet

+ const AckModeNoAck

+ type Consumer struct

+ TopicInfos map[string]string

+ func NewConsumer(cli redis.UniversalClient, opts ...optparams.Option[Options]) (*Consumer, error)

+ func (s *Consumer) Client() redis.UniversalClient

+ func (s *Consumer) Get(ctx context.Context, timeout time.Duration) ([]redis.XStream, error)

+ func (s *Consumer) Listen(topics string, opts ...optparams.Option[pchelper.ListenOptions]) error

+ func (s *Consumer) StopListening() error

+ type Options struct

+ AckMode AckModeType

+ BlockTime time.Duration

+ ClientIDOpts []optparams.Option[clientIdhelper.Options]

+ DefaultMaxLen int64

+ DefaultStart string

+ DefaultStrict bool

+ Group string

+ ProducerConsumerOpts []optparams.Option[pchelper.Options]

+ RecvBatchSize int64

+ type Producer struct

+ func NewProducer(cli redis.UniversalClient, opts ...optparams.Option[Options]) (*Producer, error)

+ func (p *Producer) Client() redis.UniversalClient

+ func (p *Producer) PubEvent(ctx context.Context, topic string, payload interface{}, ...) (*pchelper.Event, error)

+ func (p *Producer) Publish(ctx context.Context, topic string, payload interface{}, ...) error

+ type Stream struct

+ Name string

+ func NewStream(cli redis.UniversalClient, name string) *Stream

+ func (s *Stream) Ack(ctx context.Context, groupname string, ids ...string) error

+ func (s *Stream) CreateGroup(ctx context.Context, groupname string, ...) (string, error)

+ func (s *Stream) Delete(ctx context.Context, ids ...string) error

+ func (s *Stream) DeleteConsumerFromGroup(ctx context.Context, groupname, consumername string) (int64, error)

+ func (s *Stream) DeleteGroup(ctx context.Context, groupname string) (int64, error)

+ func (s *Stream) GroupInfos(ctx context.Context) ([]redis.XInfoGroup, error)

+ func (s *Stream) HasGroup(ctx context.Context, groupname string) (bool, error)

+ func (s *Stream) HasGroups(ctx context.Context, groupnames ...string) (bool, error)

+ func (s *Stream) Len(ctx context.Context) (int64, error)

+ func (s *Stream) Move(ctx context.Context, groupname, toconsumer string, minIdle time.Duration, ...) ([]redis.XMessage, error)

+ func (s *Stream) MoveJustID(ctx context.Context, groupname, toconsumer string, minIdle time.Duration, ...) ([]string, error)

+ func (s *Stream) Pending(ctx context.Context, groupname string) (*redis.XPending, error)

+ func (s *Stream) Range(ctx context.Context, start, stop string) ([]redis.XMessage, error)

+ func (s *Stream) SetGroupStartAt(ctx context.Context, groupname, start string) (string, error)

+ func (s *Stream) Trim(ctx context.Context, count int64, opts ...optparams.Option[trimOpt]) (int64, error)