gkafka

Documentation

Overview

Kafka Client.

Index

• type Client
  • func NewClient(config *Config) *Client
  • func (client *Client) AsyncSend(message *Message) error
  • func (client *Client) Close()
  • func (client *Client) Receive() (*Message, error)
  • func (client *Client) SyncSend(message *Message) error
  • func (client *Client) Topics() ([]string, error)
• type Config
  • func NewConfig() *Config
• type Message
  • func (msg *Message) MarkOffset()

Types

type Client

type Client struct {
	Config *Config
	// contains filtered or unexported fields
}

Kafka Client(Consumer/SyncProducer/AsyncProducer)

func NewClient

func NewClient(config *Config) *Client

New a kafka client.

func (*Client) AsyncSend

func (client *Client) AsyncSend(message *Message) error

Send data to kafka in asynchronized way.

func (*Client) Close

func (client *Client) Close()

Close client.

func (*Client) Receive

func (client *Client) Receive() (*Message, error)

Receive message from kafka from specified topics in config, in BLOCKING way, gkafka will handle offset tracking automatically.

func (*Client) SyncSend

func (client *Client) SyncSend(message *Message) error

Send data to kafka in synchronized way.

func (*Client) Topics

func (client *Client) Topics() ([]string, error)

Get all topics from kafka server.

type Config

type Config struct {
	GroupId        string // group id for consumer.
	Servers        string // server list, multiple servers joined by ','.
	Topics         string // topic list, multiple topics joined by ','.
	AutoMarkOffset bool   // auto mark message read after consumer message from server
	sarama.Config
}

kafka Client based on sarama.Config

func NewConfig

func NewConfig() *Config

New a default configuration object.

type Message

type Message struct {
	Value     []byte
	Key       []byte
	Topic     string
	Partition int
	Offset    int
	// contains filtered or unexported fields
}

Kafka Message.

func (*Message) MarkOffset

func (msg *Message) MarkOffset()

自动标记已读取