synchronization

Documentation

Index

• type Engine
  • func New(log zerolog.Logger, metrics module.EngineMetrics, net network.Network, ...) (*Engine, error)
  • func (e *Engine) Done() <-chan struct{}
  • func (e *Engine) Process(channel channels.Channel, originID flow.Identifier, event interface{}) error
  • func (e *Engine) ProcessLocal(event interface{}) error
  • func (e *Engine) Ready() <-chan struct{}
  • func (e *Engine) Submit(channel channels.Channel, originID flow.Identifier, event interface{})
  • func (e *Engine) SubmitLocal(event interface{})
• type RequestHandlerEngine
  • func NewRequestHandlerEngine(log zerolog.Logger, metrics module.EngineMetrics, con network.Conduit, ...) *RequestHandlerEngine
  • func (r *RequestHandlerEngine) Done() <-chan struct{}
  • func (r *RequestHandlerEngine) Process(channel channels.Channel, originID flow.Identifier, event interface{}) error
  • func (r *RequestHandlerEngine) ProcessLocal(event interface{}) error
  • func (r *RequestHandlerEngine) Ready() <-chan struct{}
  • func (r *RequestHandlerEngine) Submit(channel channels.Channel, originID flow.Identifier, event interface{})
  • func (r *RequestHandlerEngine) SubmitLocal(event interface{})

Types

type Engine

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

Engine is the synchronization engine, responsible for synchronizing chain state.

func New

func New(
	log zerolog.Logger,
	metrics module.EngineMetrics,
	net network.Network,
	me module.Local,
	participants flow.IdentityList,
	state cluster.State,
	blocks storage.ClusterBlocks,
	comp collection.Compliance,
	core module.SyncCore,
	opts ...commonsync.OptionFunc,
) (*Engine, error)

New creates a new cluster chain synchronization engine.

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(channel channels.Channel, 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(channel channels.Channel, 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) SubmitLocal

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

SubmitLocal submits an event originating on the local node.

type RequestHandlerEngine

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

func NewRequestHandlerEngine

func NewRequestHandlerEngine(
	log zerolog.Logger,
	metrics module.EngineMetrics,
	con network.Conduit,
	me module.Local,
	blocks storage.ClusterBlocks,
	core module.SyncCore,
	state cluster.State,
) *RequestHandlerEngine

func (*RequestHandlerEngine) Done

func (r *RequestHandlerEngine) Done() <-chan struct{}

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

func (*RequestHandlerEngine) Process

func (r *RequestHandlerEngine) Process(channel channels.Channel, 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 (*RequestHandlerEngine) ProcessLocal

func (r *RequestHandlerEngine) ProcessLocal(event interface{}) error

ProcessLocal processes an event originating on the local node.

func (*RequestHandlerEngine) Ready

func (r *RequestHandlerEngine) Ready() <-chan struct{}

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

func (*RequestHandlerEngine) Submit

func (r *RequestHandlerEngine) Submit(channel channels.Channel, 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 (*RequestHandlerEngine) SubmitLocal

func (r *RequestHandlerEngine) SubmitLocal(event interface{})

SubmitLocal submits an event originating on the local node.