events

Documentation

Index

• type Distributor
  • func NewDistributor() *Distributor
  • func (d *Distributor) AddConsumer(consumer protocol.Consumer)
  • func (d *Distributor) BlockFinalized(block *flow.Header)
  • func (d *Distributor) BlockProcessable(block *flow.Header, certifyingQC *flow.QuorumCertificate)
  • func (d *Distributor) EpochCommittedPhaseStarted(epoch uint64, first *flow.Header)
  • func (d *Distributor) EpochExtended(epochCounter uint64, header *flow.Header, extension flow.EpochExtension)
  • func (d *Distributor) EpochFallbackModeExited(epochCounter uint64, header *flow.Header)
  • func (d *Distributor) EpochFallbackModeTriggered(epochCounter uint64, header *flow.Header)
  • func (d *Distributor) EpochSetupPhaseStarted(epoch uint64, first *flow.Header)
  • func (d *Distributor) EpochTransition(newEpoch uint64, first *flow.Header)
• type EventLogger
  • func NewEventLogger(logger zerolog.Logger) *EventLogger
  • func (p EventLogger) EpochCommittedPhaseStarted(currentEpochCounter uint64, header *flow.Header)
  • func (p EventLogger) EpochSetupPhaseStarted(currentEpochCounter uint64, header *flow.Header)
  • func (p EventLogger) EpochTransition(newEpochCounter uint64, header *flow.Header)
• type Heights
• type Noop
  • func NewNoop() *Noop
  • func (n Noop) ActiveClustersChanged(flow.ChainIDList)
  • func (n Noop) BlockFinalized(*flow.Header)
  • func (n Noop) BlockProcessable(*flow.Header, *flow.QuorumCertificate)
  • func (n Noop) EpochCommittedPhaseStarted(uint64, *flow.Header)
  • func (n Noop) EpochExtended(uint64, *flow.Header, flow.EpochExtension)
  • func (n Noop) EpochFallbackModeExited(uint64, *flow.Header)
  • func (n Noop) EpochFallbackModeTriggered(uint64, *flow.Header)
  • func (n Noop) EpochSetupPhaseStarted(uint64, *flow.Header)
  • func (n Noop) EpochTransition(uint64, *flow.Header)
• type OnViewCallback
• type Views

Types

type Distributor

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

Distributor implements the `protocol.Consumer` interface for ingesting notifications emitted by the protocol state. It distributes the notifications to all registered consumers.

func NewDistributor

func NewDistributor() *Distributor

NewDistributor returns a new events distributor.

func (*Distributor) AddConsumer

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

func (*Distributor) BlockFinalized

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

func (*Distributor) BlockProcessable

func (d *Distributor) BlockProcessable(block *flow.Header, certifyingQC *flow.QuorumCertificate)

func (*Distributor) EpochCommittedPhaseStarted

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

func (*Distributor) EpochExtended

func (d *Distributor) EpochExtended(epochCounter uint64, header *flow.Header, extension flow.EpochExtension)

func (*Distributor) EpochFallbackModeExited

func (d *Distributor) EpochFallbackModeExited(epochCounter uint64, header *flow.Header)

func (*Distributor) EpochFallbackModeTriggered

func (d *Distributor) EpochFallbackModeTriggered(epochCounter uint64, header *flow.Header)

func (*Distributor) EpochSetupPhaseStarted

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

func (*Distributor) EpochTransition

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

type EventLogger

type EventLogger struct {
	Noop // satisfy protocol events consumer interface
	// contains filtered or unexported fields
}

func NewEventLogger

func NewEventLogger(logger zerolog.Logger) *EventLogger

func (EventLogger) EpochCommittedPhaseStarted

func (p EventLogger) EpochCommittedPhaseStarted(currentEpochCounter uint64, header *flow.Header)

func (EventLogger) EpochSetupPhaseStarted

func (p EventLogger) EpochSetupPhaseStarted(currentEpochCounter uint64, header *flow.Header)

func (EventLogger) EpochTransition

func (p EventLogger) EpochTransition(newEpochCounter uint64, header *flow.Header)

type Heights

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

type Noop struct{}

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

func NewNoop

func NewNoop() *Noop

func (Noop) ActiveClustersChanged

func (n Noop) ActiveClustersChanged(flow.ChainIDList)

func (Noop) BlockFinalized

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

func (Noop) BlockProcessable

func (n Noop) BlockProcessable(*flow.Header, *flow.QuorumCertificate)

func (Noop) EpochCommittedPhaseStarted

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

func (Noop) EpochExtended

func (n Noop) EpochExtended(uint64, *flow.Header, flow.EpochExtension)

func (Noop) EpochFallbackModeExited

func (n Noop) EpochFallbackModeExited(uint64, *flow.Header)

func (Noop) EpochFallbackModeTriggered

func (n Noop) EpochFallbackModeTriggered(uint64, *flow.Header)

func (Noop) EpochSetupPhaseStarted

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

func (Noop) EpochTransition

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

type OnViewCallback

type OnViewCallback func(*flow.Header)

OnViewCallback is the type of callback triggered by view events.

type Views

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.