pusher

Documentation

Overview

Package pusher implements an engine for providing access to resources held by the collection node, including collections, collection guarantees, and transactions.

Index

• Constants
• type Engine
  • func New(log zerolog.Logger, net module.Network, state protocol.State, ...) (*Engine, error)
  • func (e *Engine) Done() <-chan struct{}
  • func (e *Engine) Process(originID flow.Identifier, event interface{}) error
  • func (e *Engine) ProcessLocal(event interface{}) error
  • func (e *Engine) Ready() <-chan struct{}
  • func (e *Engine) Submit(originID flow.Identifier, event interface{})
  • func (e *Engine) SubmitCollectionGuarantee(guarantee *flow.CollectionGuarantee) error
  • func (e *Engine) SubmitLocal(event interface{})

Constants

const DefaultRecipientCount uint = 3

Types

type Engine

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

Engine is the collection pusher engine, which provides access to resources held by the collection node.

func New

func New(log zerolog.Logger, net module.Network, state protocol.State, engMetrics module.EngineMetrics, colMetrics module.CollectionMetrics, me module.Local, collections storage.Collections, transactions storage.Transactions) (*Engine, error)

func (*Engine) Done

func (e *Engine) Done() <-chan struct{}

Done returns a done channel that is closed once the engine has fully stopped.

func (*Engine) Process

func (e *Engine) Process(originID flow.Identifier, event interface{}) error

Process processes the given event from the node with the given origin ID in a blocking manner. It returns the potential processing error when done.

func (*Engine) ProcessLocal

func (e *Engine) ProcessLocal(event interface{}) error

ProcessLocal processes an event originating on the local node.

func (*Engine) Ready

func (e *Engine) Ready() <-chan struct{}

Ready returns a ready channel that is closed once the engine has fully started.

func (*Engine) Submit

func (e *Engine) Submit(originID flow.Identifier, event interface{})

Submit submits the given event from the node with the given origin ID for processing in a non-blocking manner. It returns instantly and logs a potential processing error internally when done.

func (*Engine) SubmitCollectionGuarantee

func (e *Engine) SubmitCollectionGuarantee(guarantee *flow.CollectionGuarantee) error

SubmitCollectionGuarantee submits the collection guarantee to all consensus nodes.

func (*Engine) SubmitLocal

func (e *Engine) SubmitLocal(event interface{})

SubmitLocal submits an event originating on the local node.