snapshot

Documentation

Index

• func CreateSnapshot(filePath string, headerProd HeaderProducerFunc, ...) (*ledger.SnapshotHeader, error)
• func LoadSnapshot(filePath string, headerConsumer HeaderConsumerFunc, ...) (err error)
• type ActivityLogConsumerFunc
• type ActivityLogProducerFunc
  • func NewActivityLogProducer(notarizationMgr *notarization.Manager, epochDiffIndex epoch.Index) ActivityLogProducerFunc
• type EpochDiffProducerFunc
  • func NewEpochDiffsProducer(fullEpochIndex, latestCommitableEpoch epoch.Index, nmgr *notarization.Manager) EpochDiffProducerFunc
• type EpochDiffsConsumerFunc
• type HeaderConsumerFunc
• type HeaderProducerFunc
• type Manager
  • func NewManager(nmgr *notarization.Manager, depth int) (new *Manager)
  • func (m *Manager) AdvanceSolidEntryPoints(ei epoch.Index)
  • func (m *Manager) CreateSnapshot(snapshotFileName string) (header *ledger.SnapshotHeader, err error)
  • func (m *Manager) InsertSolidEntryPoint(id tangleold.BlockID)
  • func (m *Manager) LoadSolidEntryPoints(seps *SolidEntryPoints)
  • func (m *Manager) RemoveSolidEntryPoint(b *tangleold.Block) (err error)
• type Snapshot
• type SolidEntryPoints
• type SolidEntryPointsConsumerFunc
• type SolidEntryPointsProducerFunc
  • func NewSolidEntryPointsProducer(fullEpochIndex, latestCommitableEpoch epoch.Index, smgr *Manager) SolidEntryPointsProducerFunc
• type UTXOStatesConsumerFunc
• type UTXOStatesProducerFunc
  • func NewLedgerUTXOStatesProducer(nmgr *notarization.Manager) UTXOStatesProducerFunc

Functions

func CreateSnapshot

func CreateSnapshot(
	filePath string,
	headerProd HeaderProducerFunc,
	sepsProd SolidEntryPointsProducerFunc,
	utxoStatesProd UTXOStatesProducerFunc,
	epochDiffsProd EpochDiffProducerFunc,
	activityLogProd ActivityLogProducerFunc) (*ledger.SnapshotHeader, error)

CreateSnapshot creates a snapshot file to the given file path.

func LoadSnapshot

func LoadSnapshot(filePath string,
	headerConsumer HeaderConsumerFunc,
	sepsConsumer SolidEntryPointsConsumerFunc,
	outputWithMetadataConsumer UTXOStatesConsumerFunc,
	epochDiffsConsumer EpochDiffsConsumerFunc,
	activityLogConsumer ActivityLogConsumerFunc) (err error)

LoadSnapshot loads a snapshot file from the given file path. Contents in a snapshot file will not be written to a snapshot struct in case blowing up the memory, they should be proccessed in consumer functions.

Types

type ActivityLogConsumerFunc

type ActivityLogConsumerFunc func(activityLogs epoch.SnapshotEpochActivity)

ActivityLogConsumerFunc is the type of function that consumes Activity logs when loading a snapshot.

type ActivityLogProducerFunc

type ActivityLogProducerFunc func() (activityLogs epoch.SnapshotEpochActivity)

ActivityLogProducerFunc is the type of function that produces ActivityLog when taking a snapshot.

func NewActivityLogProducer

func NewActivityLogProducer(notarizationMgr *notarization.Manager, epochDiffIndex epoch.Index) ActivityLogProducerFunc

NewActivityLogProducer returns an ActivityLogProducerFunc that provides activity log from weightProvider and notarization manager.

type EpochDiffProducerFunc

type EpochDiffProducerFunc func() (epochDiffs *ledger.EpochDiff)

EpochDiffProducerFunc is the type of function that produces EpochDiff when taking a snapshot.

func NewEpochDiffsProducer

func NewEpochDiffsProducer(fullEpochIndex, latestCommitableEpoch epoch.Index, nmgr *notarization.Manager) EpochDiffProducerFunc

NewEpochDiffsProducer returns a OutputWithMetadataProducerFunc that provide OutputWithMetadatas from the ledger.

type EpochDiffsConsumerFunc

type EpochDiffsConsumerFunc func(epochDiffs *ledger.EpochDiff)

EpochDiffsConsumerFunc is the type of function that consumes EpochDiff when loading a snapshot.

type HeaderConsumerFunc

type HeaderConsumerFunc func(header *ledger.SnapshotHeader)

HeaderConsumerFunc is the type of function that consumes snapshot header when loading a snapshot.

type HeaderProducerFunc

type HeaderProducerFunc func() (header *ledger.SnapshotHeader, err error)

HeaderProducerFunc is the type of function that produces snapshot header when taking a snapshot.

type Manager

type Manager struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

Manager is the snapshot manager.

func NewManager

func NewManager(nmgr *notarization.Manager, depth int) (new *Manager)

NewManager creates and returns a new snapshot manager.

func (*Manager) AdvanceSolidEntryPoints

func (m *Manager) AdvanceSolidEntryPoints(ei epoch.Index)

AdvanceSolidEntryPoints remove seps of old epoch when confirmed epoch advanced.

func (*Manager) CreateSnapshot

func (m *Manager) CreateSnapshot(snapshotFileName string) (header *ledger.SnapshotHeader, err error)

CreateSnapshot creates a snapshot file from node with a given name.

func (*Manager) InsertSolidEntryPoint

func (m *Manager) InsertSolidEntryPoint(id tangleold.BlockID)

InsertSolidEntryPoint inserts a solid entry point to the seps map.

func (*Manager) LoadSolidEntryPoints

func (m *Manager) LoadSolidEntryPoints(seps *SolidEntryPoints)

LoadSolidEntryPoints add solid entry points to storage.

func (*Manager) RemoveSolidEntryPoint

func (m *Manager) RemoveSolidEntryPoint(b *tangleold.Block) (err error)

RemoveSolidEntryPoint removes a solid entry points from the map.

type Snapshot

type Snapshot struct {
	LedgerSnapshot *ledger.Snapshot
}

Snapshot contains the data to be put in a snapshot file.

type SolidEntryPoints

type SolidEntryPoints struct {
	EI   epoch.Index         `serix:"0"`
	Seps []tangleold.BlockID `serix:"1,lengthPrefixType=uint32"`
}

SolidEntryPoints contains solid entry points of an epoch.

type SolidEntryPointsConsumerFunc

type SolidEntryPointsConsumerFunc func(seps *SolidEntryPoints)

SolidEntryPointsConsumerFunc is the type of function that consumes solid entry points when loading a snapshot.

type SolidEntryPointsProducerFunc

type SolidEntryPointsProducerFunc func() (seps *SolidEntryPoints)

SolidEntryPointsProducerFunc is the type of function that produces solid entry points when taking a snapshot.

func NewSolidEntryPointsProducer

func NewSolidEntryPointsProducer(fullEpochIndex, latestCommitableEpoch epoch.Index, smgr *Manager) SolidEntryPointsProducerFunc

NewSolidEntryPointsProducer returns a SolidEntryPointsProducerFunc that provide solid entry points from the snapshot manager.

type UTXOStatesConsumerFunc

type UTXOStatesConsumerFunc func(outputWithMetadatas []*ledger.OutputWithMetadata)

UTXOStatesConsumerFunc is the type of function that consumes OutputWithMetadatas when loading a snapshot.

type UTXOStatesProducerFunc

type UTXOStatesProducerFunc func() (outputWithMetadata *ledger.OutputWithMetadata)

UTXOStatesProducerFunc is the type of function that produces OutputWithMetadatas when taking a snapshot.

func NewLedgerUTXOStatesProducer

func NewLedgerUTXOStatesProducer(nmgr *notarization.Manager) UTXOStatesProducerFunc

NewLedgerUTXOStatesProducer returns a OutputWithMetadataProducerFunc that provide OutputWithMetadatas from the ledger.