cache

Documentation

Index

• Constants
• func Clear(prefix string) error
• func Delete(key string) error
• func EntityStmtCacheKey(subID, issID string) string
• func Get(key string, target any) (bool, error)
• func Key(subsystem ...string) string
• func Set(key string, value any, duration time.Duration) error
• func SetCache(cache Cache)
• func SetMaxLifetime(d time.Duration)
• func UseNoopCache()
• func UseRedisCache(options *redis.Options) error
• type Cache

Constants

const (
	KeyEntityStatement            = "entity_statement"
	KeyOPMetadata                 = "op_metadata"
	KeyEntityConfiguration        = "entity_configuration"
	KeyTrustTree                  = "trust_tree"
	KeyTrustTreeChains            = "trust_tree_chains"
	KeyTrustChainResolvedMetadata = "trustchain_resolved_metadata"
	KeySubordinateListing         = "subordinate_listing"
	KeyExplicitRegistration       = "explicit_registration"
)

Constants for keys for sub caches

Functions

func Clear

func Clear(prefix string) error

Clear clears all entries with the given prefix

func Delete

func Delete(key string) error

Delete deletes the value for the given key from the cache

func EntityStmtCacheKey

func EntityStmtCacheKey(subID, issID string) string

EntityStmtCacheKey constructs a cache key for an EntityStatementPayload

func Get

func Get(key string, target any) (bool, error)

Get obtains a value for the given key from the cache

func Key

func Key(subsystem ...string) string

Key combines a sub system prefix with the key to a cache key

func Set

func Set(key string, value any, duration time.Duration) error

Set caches a value for the given key and duration in the cache

func SetCache

func SetCache(cache Cache)

SetCache sets the Cache that is used

func SetMaxLifetime

func SetMaxLifetime(d time.Duration)

SetMaxLifetime sets a maximum lifetime for all cache entries. If d <= 0, the limit is disabled.

func UseNoopCache

func UseNoopCache()

UseNoopCache configures the global cache to a no-op implementation, effectively disabling caching across the library.

func UseRedisCache

func UseRedisCache(options *redis.Options) error

UseRedisCache creates a new redis cache with the passed options and sets it to be used

Types

type Cache

type Cache interface {
	Get(key string, target any) (bool, error)
	Set(key string, value any, expiration time.Duration) error
	Delete(key string) error
	// Clear clears all entries with the given prefix
	Clear(prefix string) error
}

Cache is an interface for caching data