events

package

v0.23.6 Latest Latest Go to latest Published: Jan 14, 2022 License: AGPL-3.0 Imports: 3 Imported by: 6

Details

This section is empty.

This section is empty.

This section is empty.

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

Distributor distributes events to a list of subscribers.

func NewDistributor() *Distributor

NewDistributor returns a new events distributor.

func (d *Distributor) AddConsumer(consumer protocol.Consumer)

func (d *Distributor) BlockFinalized(block *flow.Header)

func (d *Distributor) BlockProcessable(block *flow.Header)

func (d *Distributor) EpochCommittedPhaseStarted(epoch uint64, first *flow.Header)

func (d *Distributor) EpochSetupPhaseStarted(epoch uint64, first *flow.Header)

func (d *Distributor) EpochTransition(newEpoch uint64, first *flow.Header)

type Heights interface {

	// OnHeight registers the callback for the given height.
	OnHeight(height uint64, callback func())
}

Heights enables subscribing to specific heights. The callback is invoked when the given height is finalized.

type Noop struct{}

Noop is a no-op implementation of protocol.Events.

func NewNoop() *Noop

func (n Noop) BlockFinalized(block *flow.Header)

func (n Noop) BlockProcessable(block *flow.Header)

func (n Noop) EpochCommittedPhaseStarted(epoch uint64, first *flow.Header)

func (n Noop) EpochSetupPhaseStarted(epoch uint64, first *flow.Header)

func (n Noop) EpochTransition(newEpoch uint64, first *flow.Header)

type OnViewCallback func(*flow.Header)

OnViewCallback is the type of callback triggered by view events.

type Views interface {
	// OnView registers the callback for the given view.
	OnView(view uint64, callback OnViewCallback)
}

Views enables subscribing to specific views. The callback is invoked when the first block of the given view is finalized.

Path	Synopsis
gadgets
mock