redis

Documentation

Overview

Package redis is a wrapper of the original "github.com/go-redis/redis/v8" library.

Only contains basic publish, subscribe, and close methods. Data will be encoded to JSON before publishing the message.

Index

• type Channel
  • func (c *Channel) Close() error
  • func (c *Channel) Read(model interface{}) (<-chan interface{}, <-chan error)
• type Client
  • func New(address, password string) (*Client, error)
  • func NewFromGoRedis(client *redis.Client) *Client
  • func NewWithConfig(option redis.Options) (*Client, error)
  • func (c *Client) Close() error
  • func (c *Client) Publish(channel string, data interface{}) error
  • func (c *Client) Subscribe(channel string) (interface{}, error)

Types

type Channel

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

Channel is redis pubsub channel.

func (*Channel) Close

func (c *Channel) Close() error

Close to close subscription.

func (*Channel) Read

func (c *Channel) Read(model interface{}) (<-chan interface{}, <-chan error)

Read to read incoming message.

type Client

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

Client is redis pubsub client.

func New

func New(address, password string) (*Client, error)

New to create new redis pubsub client.

func NewFromGoRedis

func NewFromGoRedis(client *redis.Client) *Client

NewFromGoRedis to create pubsub from go-redis client.

func NewWithConfig

func NewWithConfig(option redis.Options) (*Client, error)

NewWithConfig to create pubsub from go-redis options.

func (*Client) Close

func (c *Client) Close() error

Close to close redis pubsub client.

func (*Client) Publish

func (c *Client) Publish(channel string, data interface{}) error

Publish to publish message.

func (*Client) Subscribe

func (c *Client) Subscribe(channel string) (interface{}, error)

Subscribe to subscribe channel.