nitecache

Nov 6, 2023

Changes in this version

+ type BatchEvictionErrs []batchEvictionErr

+ func (b BatchEvictionErrs) AffectedKeys() []string

+ func (b BatchEvictionErrs) Error() string

type Table

+ func (t *Table[T]) EvictAll(ctx context.Context, keys []string) error

Nov 3, 2023

Changes in this version

+ var ErrCacheDestroyed = errors.New("can't use cache after tear down")

+ var ErrRPCNotFound = errors.New("RPC not found")

+ func GRPCServerOpts(opts ...grpc.ServerOption) func(c *Cache)

+ func GRPCTransportCredentials(opts credentials.TransportCredentials) func(c *Cache)

type Cache

+ func (c *Cache) HealthCheckPeers(ctx context.Context) error

+ func (c *Cache) ListenAndServe() error

+ type GobCodec struct

+ func (c GobCodec[T]) Decode(b []byte, v *T) error

+ func (c GobCodec[T]) Encode(v T) ([]byte, error)

+ type JsonCodec struct

+ func (c JsonCodec[T]) Decode(b []byte, v *T) error

+ func (c JsonCodec[T]) Encode(v T) ([]byte, error)

type Metrics

+ Call map[string]int64

+ type Procedure func(ctx context.Context, v T, args []byte) (T, time.Duration, error)

+ type Storage interface

+ Evict func(key string) bool

+ Get func(key string, opt ...inmem.Opt) (item, bool)

+ Put func(key string, value item, opt ...inmem.Opt) bool

+ func LFU(threshold int) Storage

+ func LRU(threshold int) Storage

+ type StringCodec struct

+ func (c StringCodec[T]) Decode(b []byte, v *T) error

+ func (c StringCodec[T]) Encode(v T) ([]byte, error)

type Table

+ func (t *Table[T]) Call(ctx context.Context, key, function string, args []byte) (T, error)

type TableBuilder

+ func (tb *TableBuilder[T]) WithProcedure(name string, function Procedure[T]) *TableBuilder[T]

+ func (tb *TableBuilder[T]) WithStorage(storage Storage) *TableBuilder[T]

Apr 22, 2023

Changes in this version

+ func HashFuncOpt(hashFunc HashFunc) func(c *Cache)

+ func TimeoutOpt(timeout time.Duration) func(c *Cache)

+ func VirtualNodeOpt(nodes int) func(c *Cache)

+ type CacheOpt func(c *Cache)

Mar 27, 2023

Changes in this version

+ type Codec interface

+ Decode func(bytes []byte, value *T) error

+ Encode func(value T) ([]byte, error)

type TableBuilder

+ func (tb *TableBuilder[T]) WithCodec(codec Codec[T]) *TableBuilder[T]

Mar 25, 2023

Changes in this version

+ var ErrKeyNotFound = errors.New("key not found")

+ var ErrMissingMembers = errors.New("peers must contain at least one member")

+ type Cache struct

+ func NewCache(selfID string, peers []Member, opts CacheOpts) (*Cache, error)

+ func (c *Cache) GetMetrics() Metrics

+ func (c *Cache) SetPeers(peers []Member) error

+ func (c *Cache) TearDown() error

type CacheOpts

+ HashFunc HashFunc

+ Timeout time.Duration

+ type HashFunc func(key string) (int, error)

+ type Member struct

+ Addr string

+ ID string

+ type Members []Member

type Table

+ func (t Table[T]) TearDown()

Feb 23, 2023

Changes in this version

type Table

+ func (t Table[T]) GetHot(key string) (T, error)

type TableBuilder

+ func (t *TableBuilder[T]) WithHotCache() *TableBuilder[T]

Feb 23, 2023

Changes in this version

+ var ErrDuplicatePeer = errors.New("duplicate peer detected")

+ var ErrFunctionNotFound = errors.New("table function not found")

+ var ErrInitAlreadyCalled = errors.New("Init already called")

+ var ErrInvalidPeerAddr = errors.New("invalid peer address")

+ var ErrMissingPeer = errors.New("peers must contain at least one member")

+ var ErrMissingPeerDiscoveryInterval = errors.New("missing field PeerDiscoveryInterval in CacheOpts")

+ var ErrMissingSelfInPeers = errors.New("peers must contain the current node")

+ var ErrTableKeyNotFound = errors.New("Table key not found")

+ var ErrTableNotFound = errors.New("table not found")

+ func Init(self Peer, opts CacheOpts) error

+ type CacheOpts struct

+ PeerDiscovery func() []Peer

+ PeerDiscoveryInterval time.Duration

+ VirtualNodes int

+ type EvictionPolicy interface

+ type Function func(v T, args []byte) (T, time.Duration, error)

+ type Getter func(key string) (T, time.Duration, error)

+ type Lfu struct

+ func NewLfuPolicy(threshold int64) *Lfu

+ type Lru struct

+ func NewLruPolicy(threshold int64) *Lru

+ type Metrics struct

+ Evict int64

+ Execute map[string]int64

+ Get int64

+ Miss int64

+ Put int64

+ func GetMetrics() Metrics

+ type NoEvictionPolicy struct

+ type Peer struct

+ Addr string

+ ID string

+ type Table struct

+ func (t Table[T]) Evict(ctx context.Context, key string) error

+ func (t Table[T]) Execute(ctx context.Context, key, function string, args []byte) (T, error)

+ func (t Table[T]) Get(ctx context.Context, key string) (T, error)

+ func (t Table[T]) GetMetrics() Metrics

+ func (t Table[T]) Put(ctx context.Context, key string, value T, ttl time.Duration) error

+ type TableBuilder struct

+ func NewTable(name string) *TableBuilder[T]

+ func (b *TableBuilder[T]) Build() *Table[T]

+ func (t *TableBuilder[T]) WithEvictionPolicy(policy EvictionPolicy) *TableBuilder[T]

+ func (t *TableBuilder[T]) WithFunction(name string, function Function[T]) *TableBuilder[T]

+ func (t *TableBuilder[T]) WithGetter(fn Getter[T]) *TableBuilder[T]