galaxycache

package module

Go to main page

Versions in this module

v1

v1.4.1

Jan 7, 2026

v1.4.0

Dec 16, 2025

Changes in this version

+ type BackendGetInfo struct

+ Expiration time.Time

+ type BackendGetterWithInfo interface

+ GetWithInfo func(ctx context.Context, key string, dest Codec) (BackendGetInfo, error)

type GalaxyOption

+ func WithGetTTL(maxTTL, jitter time.Duration) GalaxyOption

type GetInfo

+ Expiry time.Time

+ type GetterFuncWithInfo func(ctx context.Context, key string, dest Codec) (BackendGetInfo, error)

+ func (f GetterFuncWithInfo) Get(ctx context.Context, key string, dest Codec) error

+ func (f GetterFuncWithInfo) GetWithInfo(ctx context.Context, key string, dest Codec) (BackendGetInfo, error)

type PeekPeerCfg

+ PeekedValueMaxTTL time.Duration

+ PeekedValueTTLJitter time.Duration

+ type RemoteFetcherWithInfo interface

+ FetchWithInfo func(context context.Context, galaxy string, key string) ([]byte, BackendGetInfo, error)

+ PeekWithInfo func(context context.Context, galaxy string, key string) ([]byte, BackendGetInfo, error)

type Universe

+ func (universe *Universe) NewGalaxyWithBackendInfo(name string, cacheBytes int64, getter BackendGetterWithInfo, ...) *Galaxy

v1.4.0-rc2

Dec 16, 2025

v1.4.0-rc1

Dec 8, 2025

v1.3.1

May 12, 2025

Changes in this version

+ var MCoalescedPeekErrors = stats.Int64("galaxycache/coalesced_peek_errors", ...)

type GalaxyStats

+ CoalescedPeerPeekErrors AtomicInt

v1.3.0

May 9, 2025

Changes in this version

+ var MCoalescedPeekHits = stats.Int64("galaxycache/coalesced_peek_hits", ...)

+ var MCoalescedPeeks = stats.Int64("galaxycache/coalesced_peeks", ...)

+ var MPeekErrors = stats.Int64("galaxycache/peek_errors", "The number of remote errors via Peek requests", ...)

+ var MPeeks = stats.Int64("galaxycache/peeks", "The number of remote cache hits via Peek requests", ...)

+ type FetchMode uint8

+ const FetchModeNoPeerBackend

+ const FetchModePeek

+ const FetchModeRegular

type Galaxy

+ func (g *Galaxy) GetWithOptions(ctx context.Context, opts GetOptions, key string, dest Codec) (GetInfo, error)

type GalaxyOption

+ func WithPreviousPeerPeeking(cfg PeekPeerCfg) GalaxyOption

type GalaxyStats

+ CoalescedPeerPeekHits AtomicInt

+ CoalescedPeerPeeks AtomicInt

+ PeerPeekHits AtomicInt

+ PeerPeeks AtomicInt

+ type GetInfo struct

+ type GetOptions struct

+ FetchMode FetchMode

+ type NotFoundErr interface

+ IsNotFound func()

+ type PeekPeerCfg struct

+ PeekTimeout time.Duration

+ WarmTime time.Duration

+ func (p *PeekPeerCfg) Verify() error

type RemoteFetcher

+ Peek func(context context.Context, galaxy string, key string) ([]byte, error)

+ type TrivialNotFoundErr struct

+ func (TrivialNotFoundErr) Error() string

+ func (TrivialNotFoundErr) IsNotFound()

type UniverseOpt

+ func WithUniversalClock(clock clocks.Clock) UniverseOpt

v1.2.2

May 5, 2025

v1.2.1

Apr 28, 2025

v1.2.0

Apr 16, 2025

v1.1.2

Apr 10, 2025

v1.1.1

Apr 9, 2025

Changes in this version

type Universe

+ func (universe *Universe) IncludeSelf() bool

+ func (universe *Universe) SelfID() string

v1.1.0

Apr 7, 2025

v1.0.4

Feb 26, 2025

v1.0.3

Apr 9, 2024

v1.0.2

Jun 15, 2023

v1.0.1

May 24, 2023

v1.0.0

Feb 7, 2023

Changes in this version

+ var AllViews = []*view.View

+ var CacheLevelKey = tag.MustNewKey("cache-hit-level")

+ var CacheTypeKey = tag.MustNewKey("cache-type")

+ var GalaxyKey = tag.MustNewKey("galaxy")

+ var MBackendLoadErrors = stats.Int64("galaxycache/local_load_errors", "The number of failed backend loads", ...)

+ var MBackendLoads = stats.Int64("galaxycache/backend_loads", ...)

+ var MCacheEntries = stats.Int64("galaxycache/cache_entries", "The number of entries in the cache", ...)

+ var MCacheHits = stats.Int64("galaxycache/cache_hits", "The number of times that the cache was hit", ...)

+ var MCacheSize = stats.Int64("galaxycache/cache_bytes", ...)

+ var MCoalescedBackendLoads = stats.Int64("galaxycache/coalesced_backend_loads", ...)

+ var MCoalescedCacheHits = stats.Int64("galaxycache/coalesced_cache_hits", ...)

+ var MCoalescedLoads = stats.Int64("galaxycache/coalesced_loads", "The number of loads coalesced by singleflight", ...)

+ var MCoalescedPeerLoads = stats.Int64("galaxycache/coalesced_peer_loads", ...)

+ var MGets = stats.Int64("galaxycache/gets", "The number of Get requests", stats.UnitDimensionless)

+ var MGetterFuncLatencyMilliseconds = stats.Float64("galaxycache/getterfunc_latency", ...)

+ var MKeyLength = stats.Int64("galaxycache/key_length", "The length of keys", stats.UnitBytes)

+ var MLoadErrors = stats.Int64("galaxycache/loads_errors", "The number of errors encountered during Get", ...)

+ var MLoads = stats.Int64("galaxycache/loads", "The number of gets/cacheHits", stats.UnitDimensionless)

+ var MPeerLoadErrors = stats.Int64("galaxycache/peer_errors", "The number of remote errors", ...)

+ var MPeerLoads = stats.Int64("galaxycache/peer_loads", "The number of remote loads or remote cache hits", ...)

+ var MRoundtripLatencyMilliseconds = stats.Float64("galaxycache/roundtrip_latency", "Roundtrip latency in milliseconds", ...)

+ var MServerRequests = stats.Int64("galaxycache/server_requests", ...)

+ var MValueLength = stats.Int64("galaxycache/value_length", "The length of values", stats.UnitBytes)

+ type AtomicInt struct

+ func (i *AtomicInt) Add(n int64)

+ func (i *AtomicInt) Get() int64

+ func (i *AtomicInt) String() string

+ type BackendGetter interface

+ Get func(ctx context.Context, key string, dest Codec) error

+ type ByteCodec []byte

+ func (c *ByteCodec) MarshalBinary() ([]byte, error)

+ func (c *ByteCodec) UnmarshalBinary(data []byte) error

+ type CacheStats struct

+ Bytes int64

+ Evictions int64

+ Gets int64

+ Hits int64

+ Items int64

+ type CacheType uint8

+ const CandidateCache

+ const HotCache

+ const MainCache

+ func (i CacheType) String() string

+ type Codec interface

+ MarshalBinary func() ([]byte, error)

+ UnmarshalBinary func(data []byte) error

+ type CopyingByteCodec []byte

+ func (c *CopyingByteCodec) MarshalBinary() ([]byte, error)

+ func (c *CopyingByteCodec) UnmarshalBinary(data []byte) error

+ type FetchProtocol interface

+ NewFetcher func(url string) (RemoteFetcher, error)

+ type Galaxy struct

+ Stats GalaxyStats

+ func (g *Galaxy) CacheStats(which CacheType) CacheStats

+ func (g *Galaxy) Get(ctx context.Context, key string, dest Codec) error

+ func (g *Galaxy) Name() string

+ type GalaxyOption interface

+ func WithClock(clk clocks.Clock) GalaxyOption

+ func WithHotCacheRatio(r int64) GalaxyOption

+ func WithIdleStatsAgeResetWindow(age time.Duration) GalaxyOption

+ func WithMaxCandidates(n int) GalaxyOption

+ func WithPromoter(p promoter.Interface) GalaxyOption

+ type GalaxyStats struct

+ BackendLoadErrors AtomicInt

+ BackendLoads AtomicInt

+ CoalescedBackendLoads AtomicInt

+ CoalescedHotcacheHits AtomicInt

+ CoalescedLoads AtomicInt

+ CoalescedMaincacheHits AtomicInt

+ CoalescedPeerLoads AtomicInt

+ Gets AtomicInt

+ HotcacheHits AtomicInt

+ Loads AtomicInt

+ MaincacheHits AtomicInt

+ PeerLoadErrors AtomicInt

+ PeerLoads AtomicInt

+ ServerRequests AtomicInt

+ type GetterFunc func(ctx context.Context, key string, dest Codec) error

+ func (f GetterFunc) Get(ctx context.Context, key string, dest Codec) error

+ type HCStatsWithTime struct

+ type HashOptions struct

+ HashFn consistenthash.Hash

+ Replicas int

+ type NullFetchProtocol struct

+ func (n *NullFetchProtocol) NewFetcher(url string) (RemoteFetcher, error)

+ type Peer struct

+ ID string

+ URI string

+ type PeerPicker struct

+ type RemoteFetcher interface

+ Close func() error

+ Fetch func(context context.Context, galaxy string, key string) ([]byte, error)

+ type StringCodec string

+ func (c *StringCodec) MarshalBinary() ([]byte, error)

+ func (c *StringCodec) UnmarshalBinary(data []byte) error

+ type Universe struct

+ func NewUniverse(protocol FetchProtocol, selfID string, opts ...UniverseOpt) *Universe

+ func NewUniverseWithOpts(protocol FetchProtocol, selfID string, options *HashOptions) *Universe

+ func (universe *Universe) AddPeer(peer Peer) error

+ func (universe *Universe) GetGalaxy(name string) *Galaxy

+ func (universe *Universe) ListPeers() map[string]RemoteFetcher

+ func (universe *Universe) NewGalaxy(name string, cacheBytes int64, getter BackendGetter, opts ...GalaxyOption) *Galaxy

+ func (universe *Universe) RemovePeers(ids ...string) error

+ func (universe *Universe) Set(peerURLs ...string) error

+ func (universe *Universe) SetIncludeSelf(incSelf bool)

+ func (universe *Universe) SetPeers(peers ...Peer) error

+ func (universe *Universe) Shutdown() error

+ type UniverseOpt func(*universeOpts)

+ func WithHashOpts(hashOpts *HashOptions) UniverseOpt

+ func WithRecorder(recorder stats.Recorder) UniverseOpt

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL