cindex

Documentation

Overview

Package cindex provides an interface and implementation for getting/saving consistentIndex.

Index

• type ConsistentIndexer
  • func NewConsistentIndex(tx backend.BatchTx) ConsistentIndexer
  • func NewFakeConsistentIndex(index uint64) ConsistentIndexer

Types

type ConsistentIndexer

type ConsistentIndexer interface {

	// ConsistentIndex returns the consistent index of current executing entry.
	ConsistentIndex() uint64

	// SetConsistentIndex set the consistent index of current executing entry.
	SetConsistentIndex(v uint64)

	// UnsafeSave must be called holding the lock on the tx.
	// It saves consistentIndex to the underlying stable storage.
	UnsafeSave(tx backend.BatchTx)

	// SetBatchTx set the available backend.BatchTx for ConsistentIndexer.
	SetBatchTx(tx backend.BatchTx)
}

ConsistentIndexer is an interface that wraps the Get/Set/Save method for consistentIndex.

func NewConsistentIndex

func NewConsistentIndex(tx backend.BatchTx) ConsistentIndexer

func NewFakeConsistentIndex

func NewFakeConsistentIndex(index uint64) ConsistentIndexer