redis

Documentation

Overview

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

Index

• 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(ctx context.Context, channel string, data []byte) error
  • func (c *Client) Subscribe(ctx context.Context, channel string, handlerFunc pubsub.HandlerFunc) error
  • func (c *Client) Use(middlewares ...func(pubsub.HandlerFunc) pubsub.HandlerFunc)

Types

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(ctx context.Context, channel string, data []byte) error

Publish to publish message.

func (*Client) Subscribe

func (c *Client) Subscribe(ctx context.Context, channel string, handlerFunc pubsub.HandlerFunc) error

Subscribe to subscribe channel.

func (*Client) Use

func (c *Client) Use(middlewares ...func(pubsub.HandlerFunc) pubsub.HandlerFunc)

Use to add pubsub middlewares.