cache

Mar 11, 2026

Changes in this version

type CacheEngine

+ Stats func(ctx context.Context) map[string]float64

type CacheModule

+ func (m *CacheModule) CanReload() bool

+ func (m *CacheModule) CollectMetrics(ctx context.Context) modular.ModuleMetrics

+ func (m *CacheModule) Reload(_ context.Context, changes []modular.ConfigChange) error

+ func (m *CacheModule) ReloadTimeout() time.Duration

type MemoryCache

+ func (c *MemoryCache) Stats(_ context.Context) map[string]float64

type RedisCache

+ func (c *RedisCache) Stats(_ context.Context) map[string]float64

Sep 6, 2025

Changes in this version

+ const EventTypeCacheConnected

+ const EventTypeCacheDelete

+ const EventTypeCacheDisconnected

+ const EventTypeCacheError

+ const EventTypeCacheEvicted

+ const EventTypeCacheExpired

+ const EventTypeCacheFlush

+ const EventTypeCacheGet

+ const EventTypeCacheHit

+ const EventTypeCacheMiss

+ const EventTypeCacheSet

+ var ErrNoSubjectForEventEmission = errors.New("no subject available for event emission")

type CacheModule

+ func (m *CacheModule) EmitEvent(ctx context.Context, event cloudevents.Event) error

+ func (m *CacheModule) GetRegisteredEventTypes() []string

+ func (m *CacheModule) RegisterObservers(subject modular.Subject) error

type MemoryCache

+ func (c *MemoryCache) CleanupNow(ctx context.Context)

+ func (c *MemoryCache) SetEventEmitter(emitter func(ctx context.Context, event cloudevents.Event))

+ func (c *MemoryCache) TriggerCleanupIfNeeded(ctx context.Context)

May 26, 2025

Changes in this version

+ const ModuleName

+ const ServiceName

+ var ErrCacheFull = errors.New("cache is full")

+ var ErrInvalidKey = errors.New("invalid cache key")

+ var ErrInvalidValue = errors.New("invalid cache value")

+ var ErrNotConnected = errors.New("cache not connected")

+ func NewModule() modular.Module

+ type CacheConfig struct

+ CleanupInterval int

+ ConnectionMaxAge int

+ DefaultTTL int

+ Engine string

+ MaxItems int

+ RedisDB int

+ RedisPassword string

+ RedisURL string

+ type CacheEngine interface

+ Close func(ctx context.Context) error

+ Connect func(ctx context.Context) error

+ Delete func(ctx context.Context, key string) error

+ DeleteMulti func(ctx context.Context, keys []string) error

+ Flush func(ctx context.Context) error

+ Get func(ctx context.Context, key string) (interface{}, bool)

+ GetMulti func(ctx context.Context, keys []string) (map[string]interface{}, error)

+ Set func(ctx context.Context, key string, value interface{}, ttl time.Duration) error

+ SetMulti func(ctx context.Context, items map[string]interface{}, ttl time.Duration) error

+ type CacheModule struct

+ func (m *CacheModule) Constructor() modular.ModuleConstructor

+ func (m *CacheModule) Delete(ctx context.Context, key string) error

+ func (m *CacheModule) DeleteMulti(ctx context.Context, keys []string) error

+ func (m *CacheModule) Dependencies() []string

+ func (m *CacheModule) Flush(ctx context.Context) error

+ func (m *CacheModule) Get(ctx context.Context, key string) (interface{}, bool)

+ func (m *CacheModule) GetMulti(ctx context.Context, keys []string) (map[string]interface{}, error)

+ func (m *CacheModule) Init(app modular.Application) error

+ func (m *CacheModule) Name() string

+ func (m *CacheModule) ProvidesServices() []modular.ServiceProvider

+ func (m *CacheModule) RegisterConfig(app modular.Application) error

+ func (m *CacheModule) RequiresServices() []modular.ServiceDependency

+ func (m *CacheModule) Set(ctx context.Context, key string, value interface{}, ttl time.Duration) error

+ func (m *CacheModule) SetMulti(ctx context.Context, items map[string]interface{}, ttl time.Duration) error

+ func (m *CacheModule) Start(ctx context.Context) error

+ func (m *CacheModule) Stop(ctx context.Context) error

+ type MemoryCache struct

+ func NewMemoryCache(config *CacheConfig) *MemoryCache

+ func (c *MemoryCache) Close(_ context.Context) error

+ func (c *MemoryCache) Connect(ctx context.Context) error

+ func (c *MemoryCache) Delete(_ context.Context, key string) error

+ func (c *MemoryCache) DeleteMulti(ctx context.Context, keys []string) error

+ func (c *MemoryCache) Flush(_ context.Context) error

+ func (c *MemoryCache) Get(_ context.Context, key string) (interface{}, bool)

+ func (c *MemoryCache) GetMulti(ctx context.Context, keys []string) (map[string]interface{}, error)

+ func (c *MemoryCache) Set(_ context.Context, key string, value interface{}, ttl time.Duration) error

+ func (c *MemoryCache) SetMulti(ctx context.Context, items map[string]interface{}, ttl time.Duration) error

+ type RedisCache struct

+ func NewRedisCache(config *CacheConfig) *RedisCache

+ func (c *RedisCache) Close(ctx context.Context) error

+ func (c *RedisCache) Connect(ctx context.Context) error

+ func (c *RedisCache) Delete(ctx context.Context, key string) error

+ func (c *RedisCache) DeleteMulti(ctx context.Context, keys []string) error

+ func (c *RedisCache) Flush(ctx context.Context) error

+ func (c *RedisCache) Get(ctx context.Context, key string) (interface{}, bool)

+ func (c *RedisCache) GetMulti(ctx context.Context, keys []string) (map[string]interface{}, error)

+ func (c *RedisCache) Set(ctx context.Context, key string, value interface{}, ttl time.Duration) error

+ func (c *RedisCache) SetMulti(ctx context.Context, items map[string]interface{}, ttl time.Duration) error