Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  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

consumer

package module

Go to main page

Versions in this module

v0

v0.3.5

Sep 2, 2021

Changes in this version

type Option

+ func WithAggregation(a bool) Option

+ func WithShardClosedHandler(h ShardClosedHandler) Option

type Record

+ MillisBehindLatest *int64

+ ShardID string

+ type ShardClosedHandler = func(streamName, shardID string) error

v0.3.4

Apr 28, 2020

Changes in this version

type Option

+ func WithMaxRecords(n int64) Option

+ func WithScanInterval(d time.Duration) Option

v0.3.3

Aug 31, 2019

Changes in this version

+ var ErrSkipCheckpoint = errors.New("skip checkpoint")

+ type AllGroup struct

+ func NewAllGroup(ksis kinesisiface.KinesisAPI, store Store, streamName string, logger Logger) *AllGroup

+ func (g *AllGroup) Start(ctx context.Context, shardc chan *kinesis.Shard)

+ type Group interface

+ GetCheckpoint func(streamName, shardID string) (string, error)

+ SetCheckpoint func(streamName, shardID, sequenceNumber string) error

+ Start func(ctx context.Context, shardc chan *kinesis.Shard)

type Option

+ func WithGroup(group Group) Option

+ func WithStore(store Store) Option

+ func WithTimestamp(t time.Time) Option

+ type Store interface

+ GetCheckpoint func(streamName, shardID string) (string, error)

+ SetCheckpoint func(streamName, shardID, sequenceNumber string) error

v0.3.2

May 6, 2019

Changes in this version

+ var SkipCheckpoint = errors.New("skip checkpoint")

+ type ScanFunc func(*Record) error

v0.3.1

Feb 18, 2019

Changes in this version

type Option

+ func WithShardIteratorType(t string) Option

v0.3.0

Nov 8, 2018

Changes in this version

+ type ScanStatus struct

+ Error error

+ SkipCheckpoint bool

+ StopScan bool

v0.2.0

Jul 28, 2018

Changes in this version

+ type Checkpoint interface

+ Get func(streamName, shardID string) (string, error)

+ Set func(streamName, shardID, sequenceNumber string) error

+ type Client interface

+ GetRecords func(ctx context.Context, streamName, shardID, lastSeqNum string) (<-chan *Record, <-chan error, error)

+ GetShardIDs func(string) ([]string, error)

+ type ClientOption func(*KinesisClient)

+ func WithKinesis(svc kinesisiface.KinesisAPI) ClientOption

+ func WithStartFromLatest() ClientOption

+ type Consumer struct

+ func New(streamName string, opts ...Option) (*Consumer, error)

+ func (c *Consumer) Scan(ctx context.Context, fn func(*Record) ScanError) error

+ func (c *Consumer) ScanShard(ctx context.Context, shardID string, fn func(*Record) ScanError) (err error)

+ type Counter interface

+ Add func(string, int64)

+ type KinesisClient struct

+ func NewKinesisClient(opts ...ClientOption) (*KinesisClient, error)

+ func (c *KinesisClient) GetRecords(ctx context.Context, streamName, shardID, lastSeqNum string) (<-chan *Record, <-chan error, error)

+ func (c *KinesisClient) GetShardIDs(streamName string) ([]string, error)

+ type Logger interface

+ Log func(...interface{})

+ func NewDefaultLogger() Logger

+ type LoggerFunc func(...interface{})

+ type Option func(*Consumer) error

+ func WithCheckpoint(checkpoint Checkpoint) Option

+ func WithClient(client Client) Option

+ func WithCounter(counter Counter) Option

+ func WithLogger(logger Logger) Option

+ type Record = kinesis.Record

+ type ScanError struct

+ Error error

+ SkipCheckpoint bool

+ StopScan bool