log

package

v0.1.2 Latest Latest Go to latest Published: Sep 9, 2022 License: Apache-2.0 Imports: 15 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

START: intro

This section is empty.

View Source

var (
	ErrOffsetOutOfRange = errors.New("the requested offset is outside the log's range")
)

This section is empty.

type Config struct {
	Segment struct {
		MaxStoreBytes uint64
		MaxIndexBytes uint64
		InitialOffset uint64
	}
}

type Log struct {
	Dir    string
	Config Config
	// contains filtered or unexported fields
}

func NewLog(dir string, c Config) (*Log, error)

func (l *Log) Append(record *Record) (uint64, error)

func (l *Log) Close() error

func (l *Log) GetLog(index uint64, out *Record) error

func (l *Log) HighestOffset() (uint64, error)

func (l *Log) LowestOffset() (uint64, error)

LowestOffset To know what nodes have the oldest and newest data and what nodes are falling behind and need to replicate.

func (l *Log) Read(off uint64) (*Record, error)

func (l *Log) Reader() io.Reader

func (l *Log) Remove() error

func (l *Log) Reset() error

func (l *Log) StoreLogs(records []*Record) error

func (l *Log) Truncate(lowest uint64) error

Truncate (In the future, periodically) call Truncate to remove old segments whose data we (hopefully) have processed by then and don’t need anymore.

type Record struct {
	Value  interface{}
	Offset uint64
}