olric

Jul 13, 2026

Changes in this version

+ var ErrMemberClosing = errors.New("member is shutting down")

Jul 4, 2026

Changes in this version

+ var ErrNotJoinedYet = errors.New("node has not joined the cluster yet")

Jun 22, 2026

Changes in this version

+ var ErrUnexpectedPipelineCmdType = errors.New("unexpected pipeline command type")

+ var ErrUnexpectedPipelineValueType = errors.New("unexpected pipeline command value type")

Mar 4, 2026

Changes in this version

type Olric

+ func (db *Olric) InitialSyncComplete() <-chan struct{}

+ func (db *Olric) WaitForInitialSync(ctx context.Context) error

Aug 10, 2025

Changes in this version

type GetResponse

+ func (g *GetResponse) Partition() uint64

Mar 15, 2025

Changes in this version

type Member

+ Meta string

Jan 7, 2025

Changes in this version

+ const DefaultPingResponse

+ const DefaultRoutingTableFetchInterval

+ const DefaultScanCount

+ const ReleaseVersion

+ var ErrClusterQuorum = errors.New("failed to find enough peers to create quorum")

+ var ErrConnRefused = errors.New("connection refused")

+ var ErrEntryTooLarge = errors.New("entry too large for the configured table size")

+ var ErrKeyFound = errors.New("key found")

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

+ var ErrKeyTooLarge = errors.New("key too large")

+ var ErrLockNotAcquired = errors.New("lock not acquired")

+ var ErrNilResponse = errors.New("storage entry is nil")

+ var ErrNoSuchLock = errors.New("no such lock")

+ var ErrNotReady = errors.New("not ready yet")

+ var ErrOperationTimeout = errors.New("operation timeout")

+ var ErrPipelineClosed = errors.New("pipeline is closed")

+ var ErrPipelineExecuted = errors.New("pipeline already executed")

+ var ErrReadQuorum = errors.New("read quorum cannot be reached")

+ var ErrServerGone = errors.New("server is gone")

+ var ErrWriteQuorum = errors.New("write quorum cannot be reached")

+ type Client interface

+ Close func(ctx context.Context) error

+ Members func(ctx context.Context) ([]Member, error)

+ NewDMap func(name string, options ...DMapOption) (DMap, error)

+ NewPubSub func(options ...PubSubOption) (*PubSub, error)

+ Ping func(ctx context.Context, address, message string) (string, error)

+ RefreshMetadata func(ctx context.Context) error

+ RoutingTable func(ctx context.Context) (RoutingTable, error)

+ Stats func(ctx context.Context, address string, options ...StatsOption) (stats.Stats, error)

+ type ClusterClient struct

+ func NewClusterClient(addresses []string, options ...ClusterClientOption) (*ClusterClient, error)

+ func (cl *ClusterClient) Close(ctx context.Context) error

+ func (cl *ClusterClient) Members(ctx context.Context) ([]Member, error)

+ func (cl *ClusterClient) NewDMap(name string, options ...DMapOption) (DMap, error)

+ func (cl *ClusterClient) NewPubSub(options ...PubSubOption) (*PubSub, error)

+ func (cl *ClusterClient) Ping(ctx context.Context, addr, message string) (string, error)

+ func (cl *ClusterClient) RefreshMetadata(ctx context.Context) error

+ func (cl *ClusterClient) RoutingTable(ctx context.Context) (RoutingTable, error)

+ func (cl *ClusterClient) Stats(ctx context.Context, address string, options ...StatsOption) (stats.Stats, error)

+ type ClusterClientOption func(c *clusterClientConfig)

+ func WithConfig(c *config.Client) ClusterClientOption

+ func WithHasher(h hasher.Hasher) ClusterClientOption

+ func WithLogger(l *log.Logger) ClusterClientOption

+ func WithRoutingTableFetchInterval(interval time.Duration) ClusterClientOption

+ type ClusterDMap struct

+ func (dm *ClusterDMap) Decr(ctx context.Context, key string, delta int) (int, error)

+ func (dm *ClusterDMap) Delete(ctx context.Context, keys ...string) (int, error)

+ func (dm *ClusterDMap) Destroy(ctx context.Context) error

+ func (dm *ClusterDMap) Expire(ctx context.Context, key string, timeout time.Duration) error

+ func (dm *ClusterDMap) Get(ctx context.Context, key string) (*GetResponse, error)

+ func (dm *ClusterDMap) GetPut(ctx context.Context, key string, value interface{}) (*GetResponse, error)

+ func (dm *ClusterDMap) Incr(ctx context.Context, key string, delta int) (int, error)

+ func (dm *ClusterDMap) IncrByFloat(ctx context.Context, key string, delta float64) (float64, error)

+ func (dm *ClusterDMap) Lock(ctx context.Context, key string, deadline time.Duration) (LockContext, error)

+ func (dm *ClusterDMap) LockWithTimeout(ctx context.Context, key string, timeout, deadline time.Duration) (LockContext, error)

+ func (dm *ClusterDMap) Name() string

+ func (dm *ClusterDMap) Pipeline(opts ...PipelineOption) (*DMapPipeline, error)

+ func (dm *ClusterDMap) Put(ctx context.Context, key string, value interface{}, options ...PutOption) error

+ func (dm *ClusterDMap) Scan(ctx context.Context, options ...ScanOption) (Iterator, error)

+ type ClusterIterator struct

+ func (i *ClusterIterator) Close()

+ func (i *ClusterIterator) Key() string

+ func (i *ClusterIterator) Next() bool

+ type ClusterLockContext struct

+ func (c *ClusterLockContext) Lease(ctx context.Context, duration time.Duration) error

+ func (c *ClusterLockContext) Unlock(ctx context.Context) error

+ type DMap interface

+ Decr func(ctx context.Context, key string, delta int) (int, error)

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

+ Destroy func(ctx context.Context) error

+ Expire func(ctx context.Context, key string, timeout time.Duration) error

+ Get func(ctx context.Context, key string) (*GetResponse, error)

+ GetPut func(ctx context.Context, key string, value interface{}) (*GetResponse, error)

+ Incr func(ctx context.Context, key string, delta int) (int, error)

+ IncrByFloat func(ctx context.Context, key string, delta float64) (float64, error)

+ Lock func(ctx context.Context, key string, deadline time.Duration) (LockContext, error)

+ LockWithTimeout func(ctx context.Context, key string, timeout, deadline time.Duration) (LockContext, error)

+ Name func() string

+ Pipeline func(opts ...PipelineOption) (*DMapPipeline, error)

+ Put func(ctx context.Context, key string, value interface{}, options ...PutOption) error

+ Scan func(ctx context.Context, options ...ScanOption) (Iterator, error)

+ type DMapOption func(*dmapConfig)

+ func StorageEntryImplementation(e func() storage.Entry) DMapOption

+ type DMapPipeline struct

+ func (dp *DMapPipeline) Close()

+ func (dp *DMapPipeline) Decr(ctx context.Context, key string, delta int) (*FutureDecr, error)

+ func (dp *DMapPipeline) Delete(ctx context.Context, key string) *FutureDelete

+ func (dp *DMapPipeline) Discard() error

+ func (dp *DMapPipeline) Exec(ctx context.Context) error

+ func (dp *DMapPipeline) Expire(ctx context.Context, key string, timeout time.Duration) (*FutureExpire, error)

+ func (dp *DMapPipeline) Get(ctx context.Context, key string) *FutureGet

+ func (dp *DMapPipeline) GetPut(ctx context.Context, key string, value interface{}) (*FutureGetPut, error)

+ func (dp *DMapPipeline) Incr(ctx context.Context, key string, delta int) (*FutureIncr, error)

+ func (dp *DMapPipeline) IncrByFloat(ctx context.Context, key string, delta float64) (*FutureIncrByFloat, error)

+ func (dp *DMapPipeline) Put(ctx context.Context, key string, value interface{}, options ...PutOption) (*FuturePut, error)

+ type EmbeddedClient struct

+ func (e *EmbeddedClient) Close(_ context.Context) error

+ func (e *EmbeddedClient) Members(_ context.Context) ([]Member, error)

+ func (e *EmbeddedClient) NewDMap(name string, options ...DMapOption) (DMap, error)

+ func (e *EmbeddedClient) NewPubSub(options ...PubSubOption) (*PubSub, error)

+ func (e *EmbeddedClient) Ping(ctx context.Context, addr, message string) (string, error)

+ func (e *EmbeddedClient) RefreshMetadata(_ context.Context) error

+ func (e *EmbeddedClient) RoutingTable(ctx context.Context) (RoutingTable, error)

+ func (e *EmbeddedClient) Stats(ctx context.Context, address string, options ...StatsOption) (stats.Stats, error)

+ type EmbeddedDMap struct

+ func (dm *EmbeddedDMap) Decr(ctx context.Context, key string, delta int) (int, error)

+ func (dm *EmbeddedDMap) Delete(ctx context.Context, keys ...string) (int, error)

+ func (dm *EmbeddedDMap) Destroy(ctx context.Context) error

+ func (dm *EmbeddedDMap) Expire(ctx context.Context, key string, timeout time.Duration) error

+ func (dm *EmbeddedDMap) Get(ctx context.Context, key string) (*GetResponse, error)

+ func (dm *EmbeddedDMap) GetPut(ctx context.Context, key string, value interface{}) (*GetResponse, error)

+ func (dm *EmbeddedDMap) Incr(ctx context.Context, key string, delta int) (int, error)

+ func (dm *EmbeddedDMap) IncrByFloat(ctx context.Context, key string, delta float64) (float64, error)

+ func (dm *EmbeddedDMap) Lock(ctx context.Context, key string, deadline time.Duration) (LockContext, error)

+ func (dm *EmbeddedDMap) LockWithTimeout(ctx context.Context, key string, timeout, deadline time.Duration) (LockContext, error)

+ func (dm *EmbeddedDMap) Name() string

+ func (dm *EmbeddedDMap) Pipeline(opts ...PipelineOption) (*DMapPipeline, error)

+ func (dm *EmbeddedDMap) Put(ctx context.Context, key string, value interface{}, options ...PutOption) error

+ func (dm *EmbeddedDMap) Scan(ctx context.Context, options ...ScanOption) (Iterator, error)

+ type EmbeddedIterator struct

+ func (e *EmbeddedIterator) Close()

+ func (e *EmbeddedIterator) Key() string

+ func (e *EmbeddedIterator) Next() bool

+ type EmbeddedLockContext struct

+ func (l *EmbeddedLockContext) Lease(ctx context.Context, duration time.Duration) error

+ func (l *EmbeddedLockContext) Unlock(ctx context.Context) error

+ type FutureDecr struct

+ func (f *FutureDecr) Result() (int, error)

+ type FutureDelete struct

+ func (f *FutureDelete) Result() (int, error)

+ type FutureExpire struct

+ func (f *FutureExpire) Result() error

+ type FutureGet struct

+ func (f *FutureGet) Result() (*GetResponse, error)

+ type FutureGetPut struct

+ func (f *FutureGetPut) Result() (*GetResponse, error)

+ type FutureIncr struct

+ func (f *FutureIncr) Result() (int, error)

+ type FutureIncrByFloat struct

+ func (f *FutureIncrByFloat) Result() (float64, error)

+ type FuturePut struct

+ func (f *FuturePut) Result() error

+ type GetResponse struct

+ func (g *GetResponse) Bool() (bool, error)

+ func (g *GetResponse) Byte() ([]byte, error)

+ func (g *GetResponse) Duration() (time.Duration, error)

+ func (g *GetResponse) Float32() (float32, error)

+ func (g *GetResponse) Float64() (float64, error)

+ func (g *GetResponse) Int() (int, error)

+ func (g *GetResponse) Int16() (int16, error)

+ func (g *GetResponse) Int32() (int32, error)

+ func (g *GetResponse) Int64() (int64, error)

+ func (g *GetResponse) Int8() (int8, error)

+ func (g *GetResponse) Scan(v interface{}) error

+ func (g *GetResponse) String() (string, error)

+ func (g *GetResponse) TTL() int64

+ func (g *GetResponse) Time() (time.Time, error)

+ func (g *GetResponse) Timestamp() int64

+ func (g *GetResponse) Uint() (uint, error)

+ func (g *GetResponse) Uint16() (uint16, error)

+ func (g *GetResponse) Uint32() (uint32, error)

+ func (g *GetResponse) Uint64() (uint64, error)

+ func (g *GetResponse) Uint8() (uint8, error)

+ type Iterator interface

+ Close func()

+ Key func() string

+ Next func() bool

+ type LockContext interface

+ Lease func(ctx context.Context, duration time.Duration) error

+ Unlock func(ctx context.Context) error

+ type Member struct

+ Birthdate int64

+ Coordinator bool

+ ID uint64

+ Name string

+ type Olric struct

+ func New(c *config.Config) (*Olric, error)

+ func (db *Olric) NewEmbeddedClient() *EmbeddedClient

+ func (db *Olric) Shutdown(ctx context.Context) error

+ func (db *Olric) Start() error

+ type PipelineOption func(pipeline *DMapPipeline)

+ func PipelineConcurrency(concurrency int) PipelineOption

+ type PubSub struct

+ func (ps *PubSub) PSubscribe(ctx context.Context, channels ...string) *redis.PubSub

+ func (ps *PubSub) PubSubChannels(ctx context.Context, pattern string) ([]string, error)

+ func (ps *PubSub) PubSubNumPat(ctx context.Context) (int64, error)

+ func (ps *PubSub) PubSubNumSub(ctx context.Context, channels ...string) (map[string]int64, error)

+ func (ps *PubSub) Publish(ctx context.Context, channel string, message interface{}) (int64, error)

+ func (ps *PubSub) Subscribe(ctx context.Context, channels ...string) *redis.PubSub

+ type PubSubOption func(option *pubsubConfig)

+ func ToAddress(addr string) PubSubOption

+ type PutOption func(*dmap.PutConfig)

+ func EX(ex time.Duration) PutOption

+ func EXAT(exat time.Duration) PutOption

+ func NX() PutOption

+ func PX(px time.Duration) PutOption

+ func PXAT(pxat time.Duration) PutOption

+ func XX() PutOption

+ type Route struct

+ PrimaryOwners []string

+ ReplicaOwners []string

+ type RoutingTable map[uint64]Route

+ type ScanOption func(*dmap.ScanConfig)

+ func Count(c int) ScanOption

+ func Match(s string) ScanOption

+ type StatsOption func(*statsConfig)

+ func CollectRuntime() StatsOption