cRedis

Documentation

Index

• Constants
• Variables
• func AddConnection(ctx *gin.Context, name string, config *RedisConf_Client) error
• func Client(ctx *gin.Context, name ...string) *redis.Client
• type ConnectorInterface
• type GoRedisConnector
  • func NewGoRedisConnector(connection string, config *RedisConf_Client) *GoRedisConnector
  • func (i *GoRedisConnector) Connect() error
  • func (i *GoRedisConnector) GetClient() *redis.Client
  • func (i *GoRedisConnector) GetConnection() string
• type RedisComponent
  • func (i *RedisComponent) Inject(instance any) bool
  • func (i *RedisComponent) InjectConf(config cComponents.ConfigInterface) bool
  • func (i *RedisComponent) Listen() []*cComponents.ConfigListener
  • func (i *RedisComponent) Load()
• type RedisConf
  • func (i *RedisConf) ConfigName() string
• type RedisConf_Client
• type RedisConf_Client_Pool
• type RedisContainer
  • func (i *RedisContainer) Get(name string) any
  • func (i *RedisContainer) Is(instance any) bool
  • func (i *RedisContainer) Range(f func(instance any))
  • func (i *RedisContainer) Remove(name string) bool
  • func (i *RedisContainer) Save(instance any) bool

Constants

const (
	RedisConfigName = "RedisConf"

	DefaultClient = "default"
)

Variables

var Component = &RedisComponent{}

Functions

func AddConnection

func AddConnection(ctx *gin.Context, name string, config *RedisConf_Client) error

func Client

func Client(ctx *gin.Context, name ...string) *redis.Client

Types

type ConnectorInterface

type ConnectorInterface interface {
	GetConnection() string
	GetClient() *redis.Client
	Connect() error
}

type GoRedisConnector

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

func NewGoRedisConnector

func NewGoRedisConnector(connection string, config *RedisConf_Client) *GoRedisConnector

func (*GoRedisConnector) Connect

func (i *GoRedisConnector) Connect() error

func (*GoRedisConnector) GetClient

func (i *GoRedisConnector) GetClient() *redis.Client

func (*GoRedisConnector) GetConnection

func (i *GoRedisConnector) GetConnection() string

type RedisComponent

type RedisComponent struct{}

func (*RedisComponent) Inject

func (i *RedisComponent) Inject(instance any) bool

func (*RedisComponent) InjectConf

func (i *RedisComponent) InjectConf(config cComponents.ConfigInterface) bool

func (*RedisComponent) Listen

func (i *RedisComponent) Listen() []*cComponents.ConfigListener

func (*RedisComponent) Load

func (i *RedisComponent) Load()

type RedisConf

type RedisConf struct {
	Clients map[string]*RedisConf_Client `json:"clients"`
}

func (*RedisConf) ConfigName

func (i *RedisConf) ConfigName() string

type RedisConf_Client

type RedisConf_Client struct {
	Host         string                 `json:"host"`
	Port         int64                  `json:"port"`
	Auth         string                 `json:"auth"`
	DB           int64                  `json:"db"`
	Retries      int64                  `json:"retries"`
	DialTimeout  int64                  `json:"dial_timeout"`
	ReadTimeout  int64                  `json:"read_timeout"`
	WriteTimeout int64                  `json:"write_timeout"`
	Pool         *RedisConf_Client_Pool `json:"pool"`
}

type RedisConf_Client_Pool

type RedisConf_Client_Pool struct {
	Size         int64 `json:"size"`
	MinIdleConns int64 `json:"min_idle_conns"`
	PoolTimeout  int64 `json:"pool_timeout"`
	IdleTimeout  int64 `json:"idle_timeout"`
}

type RedisContainer

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

func (*RedisContainer) Get

func (i *RedisContainer) Get(name string) any

func (*RedisContainer) Is

func (i *RedisContainer) Is(instance any) bool

func (*RedisContainer) Range

func (i *RedisContainer) Range(f func(instance any))

func (*RedisContainer) Remove

func (i *RedisContainer) Remove(name string) bool

func (*RedisContainer) Save

func (i *RedisContainer) Save(instance any) bool