kq

Documentation

Index

• func MustNewQueue(c KqConf, handler ConsumeHandler, opts ...QueueOption) queue.MessageQueue
• func NewQueue(c KqConf, handler ConsumeHandler, opts ...QueueOption) (queue.MessageQueue, error)
• type ConsumeErrorHandler
• type ConsumeHandle
• type ConsumeHandler
  • func WithHandle(handle ConsumeHandle) ConsumeHandler
• type KqConf
• type PushOption
  • func WithAllowAutoTopicCreation() PushOption
  • func WithBalancer(balancer kafka.Balancer) PushOption
  • func WithChunkSize(chunkSize int) PushOption
  • func WithFlushInterval(interval time.Duration) PushOption
  • func WithSyncPush() PushOption
• type Pusher
  • func NewPusher(addrs []string, topic string, opts ...PushOption) *Pusher
  • func (p *Pusher) Close() error
  • func (p *Pusher) KPush(ctx context.Context, k, v string) error
  • func (p *Pusher) Name() string
  • func (p *Pusher) Push(ctx context.Context, v string) error
  • func (p *Pusher) PushWithKey(ctx context.Context, key, v string) error
• type QueueOption
  • func WithCommitInterval(interval time.Duration) QueueOption
  • func WithErrorHandler(errorHandler ConsumeErrorHandler) QueueOption
  • func WithMaxWait(wait time.Duration) QueueOption
  • func WithMetrics(metrics *stat.Metrics) QueueOption
  • func WithQueueCapacity(queueCapacity int) QueueOption

Functions

func MustNewQueue

func MustNewQueue(c KqConf, handler ConsumeHandler, opts ...QueueOption) queue.MessageQueue

func NewQueue

func NewQueue(c KqConf, handler ConsumeHandler, opts ...QueueOption) (queue.MessageQueue, error)

Types

type ConsumeErrorHandler

type ConsumeErrorHandler func(ctx context.Context, msg kafka.Message, err error)

type ConsumeHandle

type ConsumeHandle func(ctx context.Context, key, value string) error

type ConsumeHandler

type ConsumeHandler interface {
	Consume(ctx context.Context, key, value string) error
}

func WithHandle

func WithHandle(handle ConsumeHandle) ConsumeHandler

type KqConf

type KqConf struct {
	service.ServiceConf
	Brokers       []string
	Group         string
	Topic         string
	CaFile        string `json:",optional"`
	Offset        string `json:",options=first|last,default=last"`
	Conns         int    `json:",default=1"`
	Consumers     int    `json:",default=8"`
	Processors    int    `json:",default=8"`
	MinBytes      int    `json:",default=10240"`    // 10K
	MaxBytes      int    `json:",default=10485760"` // 10M
	Username      string `json:",optional"`
	Password      string `json:",optional"`
	ForceCommit   bool   `json:",default=true"`
	CommitInOrder bool   `json:",default=false"`
}

type PushOption

type PushOption func(options *pushOptions)

func WithAllowAutoTopicCreation

func WithAllowAutoTopicCreation() PushOption

WithAllowAutoTopicCreation allows the Pusher to create the given topic if it does not exist.

func WithBalancer

func WithBalancer(balancer kafka.Balancer) PushOption

WithBalancer customizes the Pusher with the given balancer.

func WithChunkSize

func WithChunkSize(chunkSize int) PushOption

WithChunkSize customizes the Pusher with the given chunk size.

func WithFlushInterval

func WithFlushInterval(interval time.Duration) PushOption

WithFlushInterval customizes the Pusher with the given flush interval.

func WithSyncPush

func WithSyncPush() PushOption

WithSyncPush enables the Pusher to push messages synchronously.

type Pusher

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

func NewPusher

func NewPusher(addrs []string, topic string, opts ...PushOption) *Pusher

NewPusher returns a Pusher with the given Kafka addresses and topic.

func (*Pusher) Close

func (p *Pusher) Close() error

Close closes the Pusher and releases any resources used by it.

func (*Pusher) KPush

func (p *Pusher) KPush(ctx context.Context, k, v string) error

KPush sends a message to the Kafka topic.

func (*Pusher) Name

func (p *Pusher) Name() string

Name returns the name of the Kafka topic that the Pusher is sending messages to.

func (*Pusher) Push

func (p *Pusher) Push(ctx context.Context, v string) error

Push sends a message to the Kafka topic.

func (*Pusher) PushWithKey

func (p *Pusher) PushWithKey(ctx context.Context, key, v string) error

PushWithKey sends a message with the given key to the Kafka topic.

type QueueOption

type QueueOption func(*queueOptions)

func WithCommitInterval

func WithCommitInterval(interval time.Duration) QueueOption

func WithErrorHandler

func WithErrorHandler(errorHandler ConsumeErrorHandler) QueueOption

func WithMaxWait

func WithMaxWait(wait time.Duration) QueueOption

func WithMetrics

func WithMetrics(metrics *stat.Metrics) QueueOption

func WithQueueCapacity

func WithQueueCapacity(queueCapacity int) QueueOption