Documentation
¶
Index ¶
- Constants
- func GetAddrFromEnv() string
- func NewStore(ctx context.Context, maxTimeout, cleanupInterval time.Duration, maxConn int) (store.StoreInterface, error)
- type AccountUserDataCache
- type Marshaler
- type UserDataCache
- type UserDataCacheImpl
- func (u *UserDataCacheImpl) Delete(ctx context.Context, key string) error
- func (u *UserDataCacheImpl) Get(ctx context.Context, key string) (*idp.UserData, error)
- func (u *UserDataCacheImpl) GetUsers(ctx context.Context, key string) ([]*idp.UserData, error)
- func (u *UserDataCacheImpl) Set(ctx context.Context, key string, value *idp.UserData, expiration time.Duration) error
- func (u *UserDataCacheImpl) SetUsers(ctx context.Context, key string, users []*idp.UserData, ...) error
Constants ¶
const ( DefaultIDPCacheExpirationMax = 7 * 24 * time.Hour // 7 days DefaultIDPCacheExpirationMin = 3 * 24 * time.Hour // 3 days DefaultIDPCacheCleanupInterval = 30 * time.Minute DefaultIDPCacheOpenConn = 100 )
const ( // DefaultStoreMaxTimeout is the default max timeout for the shared cache store. DefaultStoreMaxTimeout = 7 * 24 * time.Hour // DefaultStoreCleanupInterval is the default cleanup interval for the shared cache store. DefaultStoreCleanupInterval = 30 * time.Minute // DefaultStoreMaxConn is the default max connections for the shared cache store. DefaultStoreMaxConn = 1000 )
const RedisStoreEnvVar = "NB_CACHE_REDIS_ADDRESS"
RedisStoreEnvVar is the environment variable that determines if a redis store should be used. The value should follow redis URL format. https://github.com/redis/redis-specifications/blob/master/uri/redis.txt
Variables ¶
This section is empty.
Functions ¶
func GetAddrFromEnv ¶ added in v0.69.0
func GetAddrFromEnv() string
GetAddrFromEnv returns the redis address from the environment variable RedisStoreEnvVar or its legacy counterpart.
func NewStore ¶
func NewStore(ctx context.Context, maxTimeout, cleanupInterval time.Duration, maxConn int) (store.StoreInterface, error)
NewStore creates a new cache store with the given max timeout and cleanup interval. It checks for the environment Variable RedisStoreEnvVar to determine if a redis store should be used. If the environment variable is set, it will attempt to connect to the redis store.
Types ¶
type AccountUserDataCache ¶
type AccountUserDataCache struct {
// contains filtered or unexported fields
}
AccountUserDataCache wraps the basic Get, Set and Delete methods for []*idp.UserData objects.
func NewAccountUserDataCache ¶
func NewAccountUserDataCache(loadableFunc cache.LoadFunction[any], store store.StoreInterface) *AccountUserDataCache
NewAccountUserDataCache creates a new AccountUserDataCache object.
func (*AccountUserDataCache) Delete ¶
func (a *AccountUserDataCache) Delete(ctx context.Context, key string) error
type UserDataCache ¶
type UserDataCache interface {
Get(ctx context.Context, key string) (*idp.UserData, error)
Set(ctx context.Context, key string, value *idp.UserData, expiration time.Duration) error
Delete(ctx context.Context, key string) error
GetUsers(ctx context.Context, key string) ([]*idp.UserData, error)
SetUsers(ctx context.Context, key string, users []*idp.UserData, expiration time.Duration) error
}
UserDataCache is an interface that wraps the basic Get, Set and Delete methods for idp.UserData objects.
type UserDataCacheImpl ¶
type UserDataCacheImpl struct {
// contains filtered or unexported fields
}
UserDataCacheImpl is a struct that implements the UserDataCache interface.
func NewUserDataCache ¶
func NewUserDataCache(store store.StoreInterface) *UserDataCacheImpl
NewUserDataCache creates a new UserDataCacheImpl object.
func (*UserDataCacheImpl) Delete ¶
func (u *UserDataCacheImpl) Delete(ctx context.Context, key string) error
Source Files