internal

README

redis_stream

operates on redis stream

Documentation

Index

• type Broker
  • func (s *Broker) XPub(msg *Message, maxLen int) (res string, err error)
  • func (s *Broker) XSub(stream, lastID string, blockTime int) (recv *Receiver, err error)
• type Message
• type Receiver

Types

type Broker

type Broker struct {
	Client *redis.Client
}

Broker implements a broker for message publish and subscribe

func (*Broker) XPub

func (s *Broker) XPub(msg *Message, maxLen int) (res string, err error)

XPub publishes a message to a channel. The channel is specified in the header of the message. It returns the result in string.

func (*Broker) XSub

func (s *Broker) XSub(stream, lastID string, blockTime int) (recv *Receiver, err error)

XSub subscribe a stream channel. It expects to receive messages whose ID > lastID. It returns a receiver pointer.

type Message

type Message struct {
	ID     string `json:"id"`     // message ID
	Stream string `json:"stream"` // stream to subscribe
	Body   string `json:"body"`   // message body in JSON-like text
}

Message has header and body, where header contains ID and stream channel name. Body is defined as an interface.

type Receiver

type Receiver struct {
	Stream   string       // stream to receive from
	LastID   string       // last ID we have checked
	Messages chan Message // message queue for receiving
	Shutdown func() error // function to shutdown the receiver
}

Receiver receives messages