Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ErrRequestTimeout ¶
type ErrRequestTimeout error
type ErrTooManyRequests ¶ added in v0.12.0
type ErrTooManyRequests error
type Message ¶ added in v0.11.0
type Message struct {
Key, Value []byte
Topic string
Partition int32
Offset int64
HighWaterMark int64
}
Message encapsulates a Kafka message returned by the consumer.
type T ¶
type T interface {
// Consume consumes a message from the specified topic on behalf of the
// specified consumer group. If there are no more new messages in the topic
// at the time of the request then it will block for
// `Config.Consumer.LongPollingTimeout`. If no new message is produced during
// that time, then `ErrRequestTimeout` is returned.
//
// Note that during state transitions topic subscribe<->unsubscribe and
// consumer group register<->deregister the method may return either
// `ErrBufferOverflow` or `ErrRequestTimeout` even when there are messages
// available for consumption. In that case the user should back off a bit
// and then repeat the request.
Consume(group, topic string) (*Message, error)
// Stop sends a shutdown signal to all internal goroutines and blocks until
// they are stopped. It is guaranteed that all last consumed offsets of all
// consumer groups/topics are committed to Kafka before Consumer stops.
Stop()
}
Directories
¶
| Path | Synopsis |
|---|---|
|
functional_tests
This file exists just so `go install ./...` does not complain that this directory contains "no buildable Go source files".
|
This file exists just so `go install ./...` does not complain that this directory contains "no buildable Go source files". |
Click to show internal directories.
Click to hide internal directories.