redis

Documentation

Index

• func NewRedisClient(ctx context.Context, retryOpts helper.RetryOptions, d RedisClientDependencies, ...) (contract.RedisClient, error)
• type Blackbox
• type Client
  • func NewClient(d Dependencies, opts ClientOptions) (Client, error)
  • func NewNoopClient() Client
• type ClientOption
  • func WithBatchSize(x int) ClientOption
  • func WithExpiresAfter(x time.Duration) ClientOption
• type ClientOptions
  • func ApplyClientOptions(opts *ClientOptions, modifiers ...ClientOption) ClientOptions
• type DefaultTool
  • func NewTool(c Client, opts contract.ToolOptions[Client]) *DefaultTool
  • func (d *DefaultTool) BatchFlush(ctx context.Context, keys []fmt.Stringer) error
  • func (d *DefaultTool) BatchGet(ctx context.Context, keys []fmt.Stringer) ([]contract.CacheHit, error)
  • func (d *DefaultTool) BatchSet(ctx context.Context, entries map[fmt.Stringer]contract.CacheHit) error
  • func (d *DefaultTool) Close(ctx context.Context) error
  • func (d *DefaultTool) Exists(ctx context.Context, key fmt.Stringer) (bool, error)
  • func (d *DefaultTool) Flush(ctx context.Context, pattern fmt.Stringer) error
  • func (d *DefaultTool) FlushAll(ctx context.Context) error
  • func (d *DefaultTool) Get(ctx context.Context, key fmt.Stringer) (*contract.CacheHit, error)
  • func (d *DefaultTool) Set(ctx context.Context, key fmt.Stringer, value contract.CacheHit) error
• type Dependencies
• type Loaded
• type RedisClientDependencies
• type RedisClientOptions
• type Tool

Functions

func NewRedisClient

func NewRedisClient(ctx context.Context, retryOpts helper.RetryOptions, d RedisClientDependencies, opts RedisClientOptions) (contract.RedisClient, error)

Types

type Blackbox

type Blackbox interface {
	// contains filtered or unexported methods
}

type Client

type Client interface {
	Blackbox
	contract.RedisOperator
}

func NewClient

func NewClient(d Dependencies, opts ClientOptions) (Client, error)

func NewNoopClient

func NewNoopClient() Client

type ClientOption

type ClientOption func(*ClientOptions)

func WithBatchSize

func WithBatchSize(x int) ClientOption

func WithExpiresAfter

func WithExpiresAfter(x time.Duration) ClientOption

type ClientOptions

type ClientOptions struct {
	ExpiresAfter time.Duration
	BatchSize    int
}

func ApplyClientOptions

func ApplyClientOptions(opts *ClientOptions, modifiers ...ClientOption) ClientOptions

type DefaultTool

type DefaultTool struct {
	T *contract.Tool[Client]
}

func NewTool

func NewTool(c Client, opts contract.ToolOptions[Client]) *DefaultTool

func (*DefaultTool) BatchFlush

func (d *DefaultTool) BatchFlush(ctx context.Context, keys []fmt.Stringer) error

BatchFlush removes multiple specific keys from Redis.

func (*DefaultTool) BatchGet

func (d *DefaultTool) BatchGet(ctx context.Context, keys []fmt.Stringer) ([]contract.CacheHit, error)

BatchGet retrieves multiple values from Redis by keys.

func (*DefaultTool) BatchSet

func (d *DefaultTool) BatchSet(ctx context.Context, entries map[fmt.Stringer]contract.CacheHit) error

BatchSet stores multiple key-value pairs in Redis.

func (*DefaultTool) Close

func (d *DefaultTool) Close(ctx context.Context) error

Close closes the underlying client.

func (*DefaultTool) Exists

func (d *DefaultTool) Exists(ctx context.Context, key fmt.Stringer) (bool, error)

Exists checks if a key exists in Redis.

func (*DefaultTool) Flush

func (d *DefaultTool) Flush(ctx context.Context, pattern fmt.Stringer) error

Flush removes all keys matching the given pattern from Redis.

func (*DefaultTool) FlushAll

func (d *DefaultTool) FlushAll(ctx context.Context) error

FlushAll removes all entries from Redis.

func (*DefaultTool) Get

func (d *DefaultTool) Get(ctx context.Context, key fmt.Stringer) (*contract.CacheHit, error)

Get retrieves a value from Redis by key.

func (*DefaultTool) Set

func (d *DefaultTool) Set(ctx context.Context, key fmt.Stringer, value contract.CacheHit) error

Set stores a value in Redis for a given key.

type Dependencies

type Dependencies struct {
	C contract.RedisClient
}

type Loaded

type Loaded struct {
	Username string
	Password string
}

type RedisClientDependencies

type RedisClientDependencies struct {
	C contract.CertGenerator
	F contract.FSysFileReader
}

type RedisClientOptions

type RedisClientOptions struct {
	Loaded
	FS        fs.ReadFileFS
	Port      int
	Host      string
	CertPath  string
	KeyPath   string
	CAPath    string
	UseTLS    bool
	MutualTLS bool
}

type Tool

type Tool interface {
	contract.RedisOperator
}