redis

Documentation

Index

• func GetRedis() *redis.Client
• type PlugRedis
  • func NewRedisClient() *PlugRedis
  • func (r *PlugRedis) CheckHealth() error
  • func (r *PlugRedis) CleanupTasks() error
  • func (r *PlugRedis) Configure(c any) error
  • func (r *PlugRedis) InitializeResources(rt plugins.Runtime) error
  • func (r *PlugRedis) StartupTasks() error

Functions

func GetRedis

func GetRedis() *redis.Client

GetRedis 函数用于获取 Redis 客户端实例。 它通过全局 Lynx 应用实例获取插件管理器，再根据插件名称获取对应的插件实例， 最后将插件实例转换为 *PlugRedis 类型并返回其 rdb 字段，即 Redis 客户端。

Types

type PlugRedis

type PlugRedis struct {
	// 继承基础插件
	*plugins.BasePlugin
	// contains filtered or unexported fields
}

PlugRedis 表示 Redis 插件实例

func NewRedisClient

func NewRedisClient() *PlugRedis

NewRedisClient 创建一个新的 Redis 插件实例 返回一个指向 PlugRedis 结构体的指针

func (*PlugRedis) CheckHealth

func (r *PlugRedis) CheckHealth() error

CheckHealth 实现 Redis 服务器的健康检查接口 对 Redis 服务器进行必要的健康检查，并更新提供的健康报告 参数 report 为健康报告指针，用于记录健康检查结果 返回错误信息，如果健康检查失败则返回相应错误

func (*PlugRedis) CleanupTasks

func (r *PlugRedis) CleanupTasks() error

CleanupTasks 关闭 Redis 客户端 返回错误信息，如果关闭客户端失败则返回相应错误

func (*PlugRedis) Configure

func (r *PlugRedis) Configure(c any) error

Configure 允许在运行时更新 Redis 服务器的配置 参数 c 应为指向 conf.Redis 结构体的指针，包含新的配置信息 返回错误信息，如果配置更新失败则返回相应错误

func (*PlugRedis) InitializeResources

func (r *PlugRedis) InitializeResources(rt plugins.Runtime) error

InitializeResources 实现 Redis 插件的自定义初始化逻辑 从运行时配置中扫描并加载 Redis 配置，若配置未提供则使用默认配置 参数 rt 为运行时环境 返回错误信息，如果配置加载失败则返回相应错误

func (*PlugRedis) StartupTasks

func (r *PlugRedis) StartupTasks() error

StartupTasks 启动 Redis 客户端并进行健康检查 返回错误信息，如果启动或健康检查失败则返回相应错误