kafka

Documentation

Index

• type Factory
  • func New(name, ct, topic string, brokers []string, oo ...OptionFunc) (*Factory, error)
  • func (f *Factory) Create() (async.Consumer, error)
• type Offset
  • func (o Offset) String() string
• type OptionFunc
  • func Buffer(buf int) OptionFunc
  • func Start(start Offset) OptionFunc
  • func Timeout(timeout time.Duration) OptionFunc
  • func Version(version string) OptionFunc

Types

type Factory

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

Factory definition of a consumer factory.

func New

func New(name, ct, topic string, brokers []string, oo ...OptionFunc) (*Factory, error)

New constructor.

func (*Factory) Create

func (f *Factory) Create() (async.Consumer, error)

Create a new consumer.

type Offset

type Offset int64

Offset defines the offset of messages inside a topic.

const (
	// OffsetNewest starts consuming from the newest available message in the topic.
	OffsetNewest Offset = -1
	// OffsetOldest starts consuming from the oldest available message in the topic.
	OffsetOldest Offset = -2
)

func (Offset) String

func (o Offset) String() string

type OptionFunc

type OptionFunc func(*consumer) error

OptionFunc definition for configuring the consumer in a functional way.

func Buffer

func Buffer(buf int) OptionFunc

Buffer option for adjusting the incoming messages buffer.

func Start

func Start(start Offset) OptionFunc

Start option for adjusting the start point in the topic.

func Timeout

func Timeout(timeout time.Duration) OptionFunc

Timeout option for adjusting the timeout of the connection.

func Version

func Version(version string) OptionFunc

Version option for setting the Kafka version.