keyspace_notifications

Documentation

Overview

Package keyspace_notifications对象,用于管理监听redis事件,本工具实际是pubsub中sub的一个实例

Index

• Variables
• func WithKeyEventNotificationHandler(db int, event string, fn pchelper.EventHanddler) optparams.Option[Options]
• func WithKeySpaceNotificationHandler(db int, key string, fn pchelper.EventHanddler) optparams.Option[Options]
• type KeyspaceNotification
  • func New(cli redis.UniversalClient, opts ...optparams.Option[Options]) (*KeyspaceNotification, error)
  • func (c *KeyspaceNotification) CheckConf(ctx context.Context) (string, error)
  • func (c *KeyspaceNotification) SetConf(ctx context.Context, conf string) error
  • func (s *KeyspaceNotification) Start(opts ...optparams.Option[pchelper.ListenOptions]) error
  • func (s *KeyspaceNotification) Stop() error
• type NotificationEvent
  • func FromTopicToNotificationEvent(topic, value string) (*NotificationEvent, error)
  • func (event *NotificationEvent) Topic() string
• type NotificationEventType
• type Options

Variables

var Defaultopt = Options{
	NotificationEventHandlers: map[string]pchelper.EventHanddler{},
}

Defaultopt 默认的可选配置

var ErrNoitificationsAlreadyListened = errors.New("keyspace-notification already listened")

ErrNoitificationsAlreadyListened keyspace-notification已经被监听了

var ErrNoitificationsNotListeningYet = errors.New("keyspace-notification not listrning yet")

ErrNoitificationsNotListeningYet keyspace-notification未被监听

Functions

func WithKeyEventNotificationHandler

func WithKeyEventNotificationHandler(db int, event string, fn pchelper.EventHanddler) optparams.Option[Options]

WithKeyEventNotificationHandler 注册监听KeyEvent通知的回调函数

func WithKeySpaceNotificationHandler

func WithKeySpaceNotificationHandler(db int, key string, fn pchelper.EventHanddler) optparams.Option[Options]

WithKeySpaceNotificationHandler 注册监听keyspace通知的回调函数

Types

type KeyspaceNotification

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

KeyspaceNotification 键空间通知的配置

func New

func New(cli redis.UniversalClient, opts ...optparams.Option[Options]) (*KeyspaceNotification, error)

New 创建一个键空间通知对象

func (*KeyspaceNotification) CheckConf

func (c *KeyspaceNotification) CheckConf(ctx context.Context) (string, error)

CheckConf 查看当前notify-keyspace-events的相关配置,具体可以查看<http://redisdoc.com/topic/notification.html>

func (*KeyspaceNotification) SetConf

func (c *KeyspaceNotification) SetConf(ctx context.Context, conf string) error

SetConf 设置当前的notify-keyspace-events配置<http://redisdoc.com/topic/notification.html>

func (*KeyspaceNotification) Start

func (s *KeyspaceNotification) Start(opts ...optparams.Option[pchelper.ListenOptions]) error

Start 监听事件 @params opts ...optparams.Option[pchelper.ListenOptions] 监听时的一些配置,具体看listenoption.go说明

func (*KeyspaceNotification) Stop

func (s *KeyspaceNotification) Stop() error

Stop 停止监听

type NotificationEvent

type NotificationEvent struct {
	Type      NotificationEventType `json:"type"`
	DB        string                `json:"db"`
	Key       string                `json:"key"`
	EventName string                `json:"event_name"` //事件名可以参考<http://redisdoc.com/topic/notification.html>
}

func FromTopicToNotificationEvent

func FromTopicToNotificationEvent(topic, value string) (*NotificationEvent, error)

func (*NotificationEvent) Topic

func (event *NotificationEvent) Topic() string

type NotificationEventType

type NotificationEventType uint16

NotificationEventType 通知类型

const (

	//KeySpaceNotification 键空间通知
	KeySpaceNotification NotificationEventType = iota
	//KeyEventNotification 键事件通知
	KeyEventNotification
)

type Options

type Options struct {
	NotificationEventHandlers map[string]pchelper.EventHanddler
}

Options broker的配置