redis

Documentation

Index

• func Address(address string) redisOpt
• func ApplyProperties(properties *Properties) redisOpt
• func BufferSize(size int) subscriptionOpt
• func Channels(channels ...string) subscriptionOpt
• func ConnectionTimeout(timeout time.Duration) redisOpt
• func DB(db int) redisOpt
• func NewClient(opts ...redisOpt) (*redis.Client, func(), error)
• func NewSubscription(client *redis.Client, opts ...subscriptionOpt) func()
• func OnMessage(handler func(*Message)) subscriptionOpt
• func Password(password string) redisOpt
• func PublishTimeout(timeout time.Duration) publisherOpt
• func PublisherCodec(codec MessageCodec) publisherOpt
• func SubscribeTimeout(timeout time.Duration) subscriptionOpt
• func SubscriptionCodec(codec MessageCodec, payloadStruct interface{}) subscriptionOpt
• func TLS(tls bool) redisOpt
• func TargetChannel(channel string) publisherOpt
• func Username(username string) redisOpt
• type JSONMessageCodec
  • func (codec *JSONMessageCodec) Marshall(val interface{}) ([]byte, error)
  • func (codec *JSONMessageCodec) Name() string
  • func (codec *JSONMessageCodec) Unmarshall(data []byte, target interface{}) error
• type Message
• type MessageCodec
• type Properties
• type Publisher
  • func NewPublisher(client *redis.Client, opts ...publisherOpt) (*Publisher, error)
  • func (publisher *Publisher) Publish(message interface{}) (int64, error)

Functions

func Address

func Address(address string) redisOpt

func ApplyProperties

func ApplyProperties(properties *Properties) redisOpt

func BufferSize

func BufferSize(size int) subscriptionOpt

func Channels

func Channels(channels ...string) subscriptionOpt

func ConnectionTimeout

func ConnectionTimeout(timeout time.Duration) redisOpt

func DB

func DB(db int) redisOpt

func NewClient

func NewClient(opts ...redisOpt) (*redis.Client, func(), error)

func NewSubscription

func NewSubscription(client *redis.Client, opts ...subscriptionOpt) func()

func OnMessage

func OnMessage(handler func(*Message)) subscriptionOpt

func Password

func Password(password string) redisOpt

func PublishTimeout

func PublishTimeout(timeout time.Duration) publisherOpt

func PublisherCodec

func PublisherCodec(codec MessageCodec) publisherOpt

func SubscribeTimeout

func SubscribeTimeout(timeout time.Duration) subscriptionOpt

func SubscriptionCodec

func SubscriptionCodec(codec MessageCodec, payloadStruct interface{}) subscriptionOpt

func TLS

func TLS(tls bool) redisOpt

func TargetChannel

func TargetChannel(channel string) publisherOpt

func Username

func Username(username string) redisOpt

Types

type JSONMessageCodec

type JSONMessageCodec struct {
}

func (*JSONMessageCodec) Marshall

func (codec *JSONMessageCodec) Marshall(val interface{}) ([]byte, error)

func (*JSONMessageCodec) Name

func (codec *JSONMessageCodec) Name() string

func (*JSONMessageCodec) Unmarshall

func (codec *JSONMessageCodec) Unmarshall(data []byte, target interface{}) error

type Message

type Message struct {
	Raw     *redis.Message
	Payload interface{}
}

type MessageCodec

type MessageCodec interface {
	Name() string
	Marshall(interface{}) ([]byte, error)
	Unmarshall([]byte, interface{}) error
}

type Properties

type Properties struct {
	DSN               string `json:"dsn" yaml:"dsn"`
	ConnectionTimeout int64  `json:"connectionTimeout" yaml:"connectionTimeout"`
}

type Publisher

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

func NewPublisher

func NewPublisher(client *redis.Client, opts ...publisherOpt) (*Publisher, error)

func (*Publisher) Publish

func (publisher *Publisher) Publish(message interface{}) (int64, error)