kds

Documentation

Index

• func NewKDSChan(ctx *dsl.Ctx, o interface{}) (dsl.Chan, error)
• type KDSChan
  • func (c *KDSChan) Close(ctx *dsl.Ctx) error
  • func (c *KDSChan) Consume(ctx *dsl.Ctx)
  • func (c *KDSChan) DocSpec() *dsl.DocSpec
  • func (c *KDSChan) Kill(ctx *dsl.Ctx) error
  • func (c *KDSChan) Kind() dsl.ChanKind
  • func (c *KDSChan) Open(ctx *dsl.Ctx) error
  • func (c *KDSChan) Pub(ctx *dsl.Ctx, m dsl.Msg) error
  • func (c *KDSChan) Recv(ctx *dsl.Ctx) chan dsl.Msg
  • func (c *KDSChan) Sub(ctx *dsl.Ctx, topic string) error
  • func (c *KDSChan) To(ctx *dsl.Ctx, m dsl.Msg) error
• type KDSOpts

Functions

func NewKDSChan

func NewKDSChan(ctx *dsl.Ctx, o interface{}) (dsl.Chan, error)

Types

type KDSChan

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

KDSChan is a basic Kinesis stream consumer.

This channel consumes messages from a Kinesis stream.

func (*KDSChan) Close

func (c *KDSChan) Close(ctx *dsl.Ctx) error

func (*KDSChan) Consume

func (c *KDSChan) Consume(ctx *dsl.Ctx)

func (*KDSChan) DocSpec

func (c *KDSChan) DocSpec() *dsl.DocSpec

func (*KDSChan) Kill

func (c *KDSChan) Kill(ctx *dsl.Ctx) error

func (*KDSChan) Kind

func (c *KDSChan) Kind() dsl.ChanKind

func (*KDSChan) Open

func (c *KDSChan) Open(ctx *dsl.Ctx) error

func (*KDSChan) Pub

func (c *KDSChan) Pub(ctx *dsl.Ctx, m dsl.Msg) error

func (*KDSChan) Recv

func (c *KDSChan) Recv(ctx *dsl.Ctx) chan dsl.Msg

func (*KDSChan) Sub

func (c *KDSChan) Sub(ctx *dsl.Ctx, topic string) error

func (*KDSChan) To

func (c *KDSChan) To(ctx *dsl.Ctx, m dsl.Msg) error

type KDSOpts

type KDSOpts struct {
	// StreamName is of course the name of the KDS.
	StreamName string

	// BufferSize is the size of the underlying channel buffer.
	// Defaults to DefaultChanBufferSize.
	BufferSize int
}

KDSOpts is a configuration for a Kinesis consumer for a given stream.