remotecache

Documentation

Index

• Variables
• func Get[T any](ctx context.Context, client *redis.Client, key string) (T, error)
• func GetOrCreate[T any](ctx context.Context, rc *Client, key string, ...) (T, error)
• func Release(ctx context.Context, lock RemoteLock)
• func Set[T any](ctx context.Context, client *redis.Client, key string, value T, ...) error
• type Client
  • func New(client *redis.Client, locker *redislock.Client) *Client
  • func (rc *Client) Client() *redis.Client
  • func (rc *Client) Lock(ctx context.Context, key string) (RemoteLock, error)
  • func (rc *Client) Locker() *redislock.Client
• type Options
  • func (o *Options) SetTTL(ttl time.Duration)
• type RemoteLock
  • func Lock(ctx context.Context, locker *redislock.Client, key string) (RemoteLock, error)

Variables

var Nil = redis.Nil

Nil is the error value in case the specified key does not exist

Functions

func Get

func Get[T any](ctx context.Context, client *redis.Client, key string) (T, error)

Get the specified key. Returns Nil as error if not present

func GetOrCreate

func GetOrCreate[T any](ctx context.Context, rc *Client, key string, valueFactory func(*Options) (T, error)) (T, error)

GetOrCreate the cache entry

func Release

func Release(ctx context.Context, lock RemoteLock)

Release the lock with logging the error occuring

func Set

func Set[T any](ctx context.Context, client *redis.Client, key string, value T, ttl time.Duration) error

Set the specified key to the provided value with ttl.

Types

type Client

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

Client contains the client and locker

func New

func New(client *redis.Client, locker *redislock.Client) *Client

New remote cache struct

func (*Client) Client

func (rc *Client) Client() *redis.Client

Client returns the redis client

func (*Client) Lock

func (rc *Client) Lock(ctx context.Context, key string) (RemoteLock, error)

Lock returns a new lock

func (*Client) Locker

func (rc *Client) Locker() *redislock.Client

Locker returns the redis locker

type Options

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

Options are definable options for caching an entry

func (*Options) SetTTL

func (o *Options) SetTTL(ttl time.Duration)

SetTTL sets the relative expiration of the key

type RemoteLock

type RemoteLock interface {
	Release(context.Context) error
}

RemoteLock is a lock that can be released

func Lock

func Lock(ctx context.Context, locker *redislock.Client, key string) (RemoteLock, error)

Lock the specified key and get a release method in return