factory

Documentation

Index

• func GetBloomFromConfig(cfg config.BloomFilterConfig) storageUnit.BloomConfig
• func GetCacherFromConfig(cfg config.CacheConfig) storageUnit.CacheConfig
• func GetDBFromConfig(cfg config.DBConfig) storageUnit.DBConfig
• func NewStorageUnitOpenHandler(args ArgsNewOpenStorageUnits) (*openStorageUnits, error)
• type ArgsNewOpenStorageUnits
• type LatestDataFromStorage
  • func FindLatestDataFromStorage(generalConfig config.Config, marshalizer marshal.Marshalizer, ...) (LatestDataFromStorage, error)
• type PersisterFactory
  • func NewPersisterFactory(config config.DBConfig) *PersisterFactory
  • func (pf *PersisterFactory) Create(path string) (storage.Persister, error)
  • func (pf *PersisterFactory) IsInterfaceNil() bool
• type StorageServiceFactory
  • func NewStorageServiceFactory(config *config.Config, shardCoordinator storage.ShardCoordinator, ...) (*StorageServiceFactory, error)
  • func (psf *StorageServiceFactory) CreateForMeta() (dataRetriever.StorageService, error)
  • func (psf *StorageServiceFactory) CreateForShard() (dataRetriever.StorageService, error)

Functions

func GetBloomFromConfig

func GetBloomFromConfig(cfg config.BloomFilterConfig) storageUnit.BloomConfig

GetBloomFromConfig will return the bloom config needed for storage unit from a config came from the toml file

func GetCacherFromConfig

func GetCacherFromConfig(cfg config.CacheConfig) storageUnit.CacheConfig

GetCacherFromConfig will return the cache config needed for storage unit from a config came from the toml file

func GetDBFromConfig

func GetDBFromConfig(cfg config.DBConfig) storageUnit.DBConfig

GetDBFromConfig will return the db config needed for storage unit from a config came from the toml file

func NewStorageUnitOpenHandler

func NewStorageUnitOpenHandler(args ArgsNewOpenStorageUnits) (*openStorageUnits, error)

NewStorageUnitOpenHandler creates an openStorageUnits component TODO refactor this and unit tests

Types

type ArgsNewOpenStorageUnits

type ArgsNewOpenStorageUnits struct {
	GeneralConfig      config.Config
	Marshalizer        marshal.Marshalizer
	WorkingDir         string
	ChainID            string
	DefaultDBPath      string
	DefaultEpochString string
	DefaultShardString string
}

ArgsNewOpenStorageUnits defines the arguments in order to open a set of storage units from disk

type LatestDataFromStorage

type LatestDataFromStorage struct {
	Epoch           uint32
	ShardID         uint32
	LastRound       int64
	EpochStartRound uint64
}

LatestDataFromStorage represents the DTO structure to return from storage

func FindLatestDataFromStorage

func FindLatestDataFromStorage(
	generalConfig config.Config,
	marshalizer marshal.Marshalizer,
	workingDir string,
	chainID string,
	defaultDBPath string,
	defaultEpochString string,
	defaultShardString string,
) (LatestDataFromStorage, error)

FindLatestDataFromStorage finds the last data (such as last epoch, shard ID or round) by searching over the storage folders and opening older databases

type PersisterFactory

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

PersisterFactory is the factory which will handle creating new databases

func NewPersisterFactory

func NewPersisterFactory(config config.DBConfig) *PersisterFactory

NewPersisterFactory will return a new instance of a PersisterFactory

func (*PersisterFactory) Create

func (pf *PersisterFactory) Create(path string) (storage.Persister, error)

Create will return a new instance of a DB with a given path

func (*PersisterFactory) IsInterfaceNil

func (pf *PersisterFactory) IsInterfaceNil() bool

IsInterfaceNil returns true if there is no value under the interface

type StorageServiceFactory

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

StorageServiceFactory handles the creation of storage services for both meta and shards

func NewStorageServiceFactory

func NewStorageServiceFactory(
	config *config.Config,
	shardCoordinator storage.ShardCoordinator,
	pathManager storage.PathManagerHandler,
	epochStartNotifier storage.EpochStartNotifier,
	currentEpoch uint32,
) (*StorageServiceFactory, error)

NewStorageServiceFactory will return a new instance of StorageServiceFactory

func (*StorageServiceFactory) CreateForMeta

func (psf *StorageServiceFactory) CreateForMeta() (dataRetriever.StorageService, error)

CreateForMeta will return the storage service which contains all storers needed for metachain

func (*StorageServiceFactory) CreateForShard

func (psf *StorageServiceFactory) CreateForShard() (dataRetriever.StorageService, error)

CreateForShard will return the storage service which contains all storers needed for a shard