commitlog

Documentation

Overview

Package commitlog implements commit log bootstrapping.

Index

• Constants
• func NewCommitLogBootstrapperProvider(opts Options, inspection fs.Inspection, next bootstrap.BootstrapperProvider) (bootstrap.BootstrapperProvider, error)
• type Options
  • func NewOptions() Options

Constants

const (
	// CommitLogBootstrapperName is the name of the commit log bootstrapper.
	CommitLogBootstrapperName = "commitlog"
)

const (
	// DefaultReturnUnfulfilledForCorruptCommitLogFiles is the default
	// value for whether to return unfulfilled when encountering corrupt
	// commit log files.
	DefaultReturnUnfulfilledForCorruptCommitLogFiles = false
)

Functions

func NewCommitLogBootstrapperProvider

func NewCommitLogBootstrapperProvider(
	opts Options,
	inspection fs.Inspection,
	next bootstrap.BootstrapperProvider,
) (bootstrap.BootstrapperProvider, error)

NewCommitLogBootstrapperProvider creates a new bootstrapper provider to bootstrap from commit log files.

Types

type Options

type Options interface {
	// Validate validates the options.
	Validate() error

	// SetResultOptions sets the result options.
	SetResultOptions(value result.Options) Options

	// ResultOptions returns the result options.
	ResultOptions() result.Options

	// SetCommitLogOptions sets the commit log options.
	SetCommitLogOptions(value commitlog.Options) Options

	// CommitLogOptions returns the commit log options.
	CommitLogOptions() commitlog.Options

	// SetAccumulateConcurrency sets the concurrency for accumulating.
	SetAccumulateConcurrency(value int) Options

	// AccumulateConcurrency returns the concurrency for accumulating.
	AccumulateConcurrency() int

	// SetReturnUnfulfilledForCorruptCommitLogFiles sets whether the bootstrapper
	// should return unfulfilled if it encounters corrupt commitlog files.
	SetReturnUnfulfilledForCorruptCommitLogFiles(value bool) Options

	// ReturnUnfulfilledForCorruptCommitLogFiles returns whether the bootstrapper
	// should return unfulfilled if it encounters corrupt commitlog files.
	ReturnUnfulfilledForCorruptCommitLogFiles() bool

	// SetRuntimeOptionsManagers sets the RuntimeOptionsManager.
	SetRuntimeOptionsManager(value runtime.OptionsManager) Options

	// RuntimeOptionsManagers returns the RuntimeOptionsManager.
	RuntimeOptionsManager() runtime.OptionsManager
}

Options represents the options for bootstrapping from commit logs.

func NewOptions

func NewOptions() Options

NewOptions creates new bootstrap options