log

Documentation

Index

• type Log
• type LogMemStore
  • func NewLogMemStore() *LogMemStore
  • func (l *LogMemStore) DeleteRange(min, max uint64) error
  • func (l *LogMemStore) FirstIndex() (uint64, error)
  • func (l *LogMemStore) GetLog(index uint64) (*Log, error)
  • func (l *LogMemStore) LastIndex() (uint64, error)
  • func (l *LogMemStore) StoreLog(log *Log) error
  • func (l *LogMemStore) StoreLogs(logs []*Log) error
• type LogStore

Types

type Log

type Log struct {
	// Index holds the index of the log entry
	Index uint64

	// Term holds the election term of the log entry
	Term uint64

	// Data holds the log entry's data
	Data []byte

	// AppendedAt stores the time a log was appended
	// important to reach a similar state in terms of ttl.
	// ex. if a log was appended 3 min ago and the ttl is 1 min the
	// action should not be included in the state
	AppendedAt time.Time
}

Log is a data structure that holds the log entry of the distributed cache. It is used to keep track of the state of the cache and to replicate the state across the cluster.

type LogMemStore

type LogMemStore struct {
	// contains filtered or unexported fields
}

LogMemStore is an in-memory implementation of the LogStore. should not be used like this in production, it is harder to restore a cluster to its original state.

func NewLogMemStore

func NewLogMemStore() *LogMemStore

NewLogMemStore returns an in-memory backend.

func (*LogMemStore) DeleteRange

func (l *LogMemStore) DeleteRange(min, max uint64) error

func (*LogMemStore) FirstIndex

func (l *LogMemStore) FirstIndex() (uint64, error)

func (*LogMemStore) GetLog

func (l *LogMemStore) GetLog(index uint64) (*Log, error)

func (*LogMemStore) LastIndex

func (l *LogMemStore) LastIndex() (uint64, error)

func (*LogMemStore) StoreLog

func (l *LogMemStore) StoreLog(log *Log) error

func (*LogMemStore) StoreLogs

func (l *LogMemStore) StoreLogs(logs []*Log) error

type LogStore

type LogStore interface {
	// FirstIndex returns the index of the first index written 0 if no logs
	FirstIndex() (uint64, error)

	// LastIndex returns the index of the last index written 0 if no logs
	LastIndex() (uint64, error)

	// StoreLog stores a single log entry
	StoreLog(log *Log) error

	// StoreLogs stores multiple log entries. Useful for removing a gap in the log entries.
	StoreLogs(logs []*Log) error

	// GetLog returns a log entry at the given index. returns a error if the log does not exist.
	GetLog(index uint64) (*Log, error)

	// DeleteRange deletes all log entries between start and end index. The range is inclusive.
	DeleteRange(min, max uint64) error
}