cache

Documentation

Index

• Constants
• Variables
• func ExecuteSingleCall(ctx context.Context, name string, call SingleCall) error
• func InitSingleCall(ctx context.Context, name string) error
• func Nonce(ctx context.Context, name string, nonce uint64) (uint64, error)
• func OptionArgs(args *RedisOptions)
• func RedisMutexContext(ctx context.Context) context.Context
• func ResetNonce(ctx context.Context, name string) error
• func ToRedis(cache Cache) *redis.Client
• func WithCache(ctx context.Context, cache Cache) context.Context
• type Cache
  • func FromContext(ctx context.Context) Cache
• type Lock
  • func LockAccount(ctx context.Context, accountID uint64) (Lock, error)
  • func LockBatchNetwork(ctx context.Context, batchNetwork string) (Lock, error)
  • func LockChain(ctx context.Context, chain string) (Lock, error)
  • func LockGeneric(ctx context.Context, name string) (Lock, error)
  • func LockUser(ctx context.Context, userID uint64) (Lock, error)
• type Mutex
  • func NewRedisMutex(ctx context.Context) Mutex
  • func RedisMutexFromContext(ctx context.Context) Mutex
• type RDB
• type Redis
  • func NewRedis(ctx context.Context, options RedisOptions) *Redis
  • func (r *Redis) RDB() RDB
• type RedisLock
  • func (p *RedisLock) Unlock()
• type RedisMutex
  • func (p *RedisMutex) Lock(ctx context.Context, key string, ttl time.Duration) (Lock, error)
• type RedisOptions
• type SingleCall

Constants

const (
	CacheKey       = "Key.CacheKey"
	RedisLockerKey = "Key.RedisLockerKey"
)

const (
	DefaultLockTTL = 30 * time.Second

	MinimumLockTTL = 100 * time.Millisecond
	MaximumLockTTL = 5 * time.Minute
)

const (
	DefaultNonceExpire = time.Duration(3 * time.Minute)
)

Variables

var (
	ErrRedisMutexNotFound = errors.New("RedisMutex Not Found")
	ErrLockError          = errors.New("Failed to acquire lock")
)

var (
	ErrInternalError = errors.New("InternalError")
)

var (
	ErrInvaliNonceName = errors.New("Invalid nonce name")
)

Functions

func ExecuteSingleCall

func ExecuteSingleCall(ctx context.Context, name string, call SingleCall) error

func InitSingleCall

func InitSingleCall(ctx context.Context, name string) error

func Nonce

func Nonce(ctx context.Context, name string, nonce uint64) (uint64, error)

func OptionArgs

func OptionArgs(args *RedisOptions)

func RedisMutexContext

func RedisMutexContext(ctx context.Context) context.Context

func ResetNonce

func ResetNonce(ctx context.Context, name string) error

func ToRedis

func ToRedis(cache Cache) *redis.Client

func WithCache

func WithCache(ctx context.Context, cache Cache) context.Context

WithCache returns a context with the messaging set

Types

type Cache

type Cache interface {
	RDB() RDB
}

func FromContext

func FromContext(ctx context.Context) Cache

type Lock

type Lock interface {
	Unlock()
}

func LockAccount

func LockAccount(ctx context.Context, accountID uint64) (Lock, error)

func LockBatchNetwork

func LockBatchNetwork(ctx context.Context, batchNetwork string) (Lock, error)

func LockChain

func LockChain(ctx context.Context, chain string) (Lock, error)

func LockGeneric

func LockGeneric(ctx context.Context, name string) (Lock, error)

func LockUser

func LockUser(ctx context.Context, userID uint64) (Lock, error)

type Mutex

type Mutex interface {
	Lock(ctx context.Context, key string, ttl time.Duration) (Lock, error)
}

func NewRedisMutex

func NewRedisMutex(ctx context.Context) Mutex

func RedisMutexFromContext

func RedisMutexFromContext(ctx context.Context) Mutex

type RDB

type RDB interface{}

Cache (Redis)

type Redis

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

func NewRedis

func NewRedis(ctx context.Context, options RedisOptions) *Redis

func (*Redis) RDB

func (r *Redis) RDB() RDB

type RedisLock

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

func (*RedisLock) Unlock

func (p *RedisLock) Unlock()

type RedisMutex

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

func (*RedisMutex) Lock

func (p *RedisMutex) Lock(ctx context.Context, key string, ttl time.Duration) (Lock, error)

type RedisOptions

type RedisOptions struct {
	HostName string
	Port     int
}

type SingleCall

type SingleCall func(ctx context.Context) error