client

type CacheKeyNameID string

type CacheKeyNameProvider interface {
	GetKeyName(id CacheKeyNameID, components []string) shared.CacheKey
	// GetKeyNameWithID is a wrapper around GetKeyName that converts the itemID to []string
	GetKeyNameWithID(id CacheKeyNameID, itemID uuid.UUID) shared.CacheKey
	// GetKeyNameWithString is a wrapper around GetKeyName that converts the itemName to []string
	GetKeyNameWithString(id CacheKeyNameID, itemName string) shared.CacheKey
	// GetKeyNameStatic is a wrapper around GetKeyName that passing in empty []string
	GetKeyNameStatic(id CacheKeyNameID) shared.CacheKey
}

type CacheKeyTTLID string

type CacheManager struct {
	P CacheProvider
	N CacheKeyNameProvider
	T CacheTTLProvider
}

type CacheProvider interface {
	// GetValue gets the value in cache key (if any) and tries to lock the key for Read is lockOnMiss = true
	GetValue(ctx context.Context, key shared.CacheKey, lockOnMiss bool) (*string, *string, shared.CacheSentinel, error)
	// GetValues gets the value in cache key (if any) and tries to lock the key for Read is lockOnMiss = true
	GetValues(ctx context.Context, keys []shared.CacheKey, lockOnMiss []bool) ([]*string, []*string, []shared.CacheSentinel, error)
	// SetValue sets the value in cache key(s) to val with given expiration time if the sentinel matches lkey and returns true if the value was set
	SetValue(ctx context.Context, lkey shared.CacheKey, keysToSet []shared.CacheKey, val string, sentinel shared.CacheSentinel, ttl time.Duration) (bool, bool, error)
	// DeleteValue deletes the value(s) in passed in keys, force is true also deletes keys with sentinel or tombstone values
	DeleteValue(ctx context.Context, key []shared.CacheKey, setTombstone bool, force bool) error
	// WriteSentinel writes the sentinel value into the given keys, returns NoLockSentinel if it couldn't acquire the lock
	WriteSentinel(ctx context.Context, stype shared.SentinelType, keys []shared.CacheKey) (shared.CacheSentinel, error)
	// ReleaseSentinel clears the sentinel value from the given keys
	ReleaseSentinel(ctx context.Context, keys []shared.CacheKey, s shared.CacheSentinel)
	// AddDependency adds the given cache key(s) as dependencies of an item represented by by key. Fails if any of the dependency keys passed in contain tombstone
	AddDependency(ctx context.Context, keysIn []shared.CacheKey, dependentKey []shared.CacheKey, ttl time.Duration) error
	// ClearDependencies clears the dependencies of an item represented by key and removes all dependent keys from the cache
	ClearDependencies(ctx context.Context, key shared.CacheKey, setTombstone bool) error
	// Flush flushes the cache
	Flush(ctx context.Context, prefix string, flushTombstones bool) error
	// GetCacheName returns the global name of the cache if any
	GetCacheName(ctx context.Context) string
}

type CacheSentinelManager interface {
	GenerateSentinel(stype shared.SentinelType) shared.CacheSentinel
	CanAlwaysSetSentinel(newVal shared.CacheSentinel) bool
	CanSetSentinelGivenCurrVal(currVal shared.CacheSentinel, newVal shared.CacheSentinel) bool
	CanSetValue(currVal string, val string, sentinel shared.CacheSentinel) (set bool, clear bool, conflict bool, refresh bool)
	IsSentinelValue(val string) bool
}

type CacheSingleItem interface {
	// GetPrimaryKey returns the primary cache key where the item is stored and which is used to lock the item
	GetPrimaryKey(c CacheKeyNameProvider) shared.CacheKey
	// GetSecondaryKeys returns any secondary keys which also contain the item for lookup by another dimension (ie TypeName, Alias, etc)
	GetSecondaryKeys(c CacheKeyNameProvider) []shared.CacheKey
	// GetGlobalCollectionKey returns the key for the collection of all items of this type (ie all ObjectTypes, all EdgeTypes, etc)
	GetGlobalCollectionKey(c CacheKeyNameProvider) shared.CacheKey
	// GetPerItemCollectionKey returns the key for the collection of per item items of another type (ie Edges in/out of a specific Object)
	GetPerItemCollectionKey(c CacheKeyNameProvider) shared.CacheKey
	// GetDependenciesKey returns the key containing dependent keys that should invalidated if the item is invalidated
	GetDependenciesKey(c CacheKeyNameProvider) shared.CacheKey
	// GetDependencyKeys returns the list of keys for items this item depends on (ie Edge depends on both source and target objects)
	GetDependencyKeys(c CacheKeyNameProvider) []shared.CacheKey
	// GetIsModifiedKey returns the key containing a tombstone sentinel if the item has been modified in last TTL seconds
	GetIsModifiedKey(c CacheKeyNameProvider) shared.CacheKey
	// TTL returns the TTL for the item
	TTL(c CacheTTLProvider) time.Duration
	// Validate method is used to validate the item. Every CacheSingleItem is expected to implement Validatable interface
	infra.Validateable
}

type CacheTTLProvider interface {
	TTL(id CacheKeyTTLID) time.Duration
}

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

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

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

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