notifier

Documentation

Index

• func NewEpochStartSubscriptionHandler() *epochStartSubscriptionHandler
• func NewHandlerForEpochStart(actionFunc func(hdr data.HeaderHandler), ...) epochStart.ActionHandler
• func NewManualEpochStartNotifier() *manualEpochStartNotifier
• func NewNodesConfigProvider(epochNotifier process.EpochNotifier, ...) (*nodesConfigProvider, error)
• func NewNodesConfigProviderAPI(epochNotifier process.EpochNotifier, cfg config.EnableEpochs) (*nodesConfigProviderAPI, error)
• type EpochStartNotifier

Functions

func NewEpochStartSubscriptionHandler

func NewEpochStartSubscriptionHandler() *epochStartSubscriptionHandler

NewEpochStartSubscriptionHandler returns a new instance of epochStartSubscriptionHandler

func NewHandlerForEpochStart

func NewHandlerForEpochStart(
	actionFunc func(hdr data.HeaderHandler),
	prepareFunc func(metaHeader data.HeaderHandler),
	id uint32,
) epochStart.ActionHandler

NewHandlerForEpochStart will return a struct which will satisfy the above interface

func NewManualEpochStartNotifier

func NewManualEpochStartNotifier() *manualEpochStartNotifier

NewManualEpochStartNotifier creates a new instance of a manual epoch start notifier

func NewNodesConfigProvider

func NewNodesConfigProvider(
	epochNotifier process.EpochNotifier,
	maxNodesEnableConfig []config.MaxNodesChangeConfig,
) (*nodesConfigProvider, error)

NewNodesConfigProvider returns a new instance of nodesConfigProvider, which provides the current config.MaxNodesChangeConfig based on the current epoch

func NewNodesConfigProviderAPI

func NewNodesConfigProviderAPI(
	epochNotifier process.EpochNotifier,
	cfg config.EnableEpochs,
) (*nodesConfigProviderAPI, error)

NewNodesConfigProviderAPI returns a new instance of nodes config provider for API calls only, which provides the current max nodes change config based on the current epoch

Types

type EpochStartNotifier

type EpochStartNotifier interface {
	RegisterHandler(handler epochStart.ActionHandler)
	UnregisterHandler(handler epochStart.ActionHandler)
	NotifyAll(hdr data.HeaderHandler)
	NotifyAllPrepare(metaHdr data.HeaderHandler, body data.BodyHandler)
	NotifyEpochChangeConfirmed(epoch uint32)
	RegisterForEpochChangeConfirmed(handler func(epoch uint32))
	IsInterfaceNil() bool
}

EpochStartNotifier defines which actions should be done for handling new epoch's events