snowman

Documentation

Index

• type Config
• type Engine
  • func New(config Config) (*Engine, error)
  • func (e *Engine) Chits(ctx context.Context, nodeID ids.NodeID, requestID uint32, preferredID ids.ID, ...) error
  • func (e *Engine) Context() *snow.ConsensusContext
  • func (e *Engine) GetFailed(ctx context.Context, nodeID ids.NodeID, requestID uint32) error
  • func (e *Engine) Gossip(ctx context.Context) error
  • func (*Engine) Halt(context.Context)
  • func (e *Engine) HealthCheck(ctx context.Context) (interface{}, error)
  • func (e *Engine) Notify(ctx context.Context, msg common.Message) error
  • func (e *Engine) PullQuery(ctx context.Context, nodeID ids.NodeID, requestID uint32, blkID ids.ID, ...) error
  • func (e *Engine) PushQuery(ctx context.Context, nodeID ids.NodeID, requestID uint32, blkBytes []byte, ...) error
  • func (e *Engine) Put(ctx context.Context, nodeID ids.NodeID, requestID uint32, blkBytes []byte) error
  • func (e *Engine) QueryFailed(ctx context.Context, nodeID ids.NodeID, requestID uint32) error
  • func (e *Engine) Shutdown(ctx context.Context) error
  • func (e *Engine) Start(ctx context.Context, startReqID uint32) error
  • func (*Engine) Timeout(context.Context) error

Types

type Config

type Config struct {
	common.AllGetsServer

	Ctx                 *snow.ConsensusContext
	VM                  block.ChainVM
	Sender              common.Sender
	Validators          validators.Manager
	ConnectedValidators tracker.Peers
	Params              snowball.Parameters
	Consensus           snowman.Consensus
	PartialSync         bool
}

Config wraps all the parameters needed for a snowman engine

type Engine

type Engine struct {
	Config

	// list of NoOpsHandler for messages dropped by engine
	common.StateSummaryFrontierHandler
	common.AcceptedStateSummaryHandler
	common.AcceptedFrontierHandler
	common.AcceptedHandler
	common.AncestorsHandler
	common.AppHandler
	validators.Connector
	// contains filtered or unexported fields
}

Engine implements the Engine interface by attempting to fetch all Engine dependencies.

func New

func New(config Config) (*Engine, error)

func (*Engine) Chits

func (e *Engine) Chits(ctx context.Context, nodeID ids.NodeID, requestID uint32, preferredID ids.ID, preferredIDAtHeight ids.ID, acceptedID ids.ID) error

func (*Engine) Context

func (e *Engine) Context() *snow.ConsensusContext

func (*Engine) GetFailed

func (e *Engine) GetFailed(ctx context.Context, nodeID ids.NodeID, requestID uint32) error

func (*Engine) Gossip

func (e *Engine) Gossip(ctx context.Context) error

func (*Engine) Halt

func (*Engine) Halt(context.Context)

func (*Engine) HealthCheck

func (e *Engine) HealthCheck(ctx context.Context) (interface{}, error)

func (*Engine) Notify

func (e *Engine) Notify(ctx context.Context, msg common.Message) error

func (*Engine) PullQuery

func (e *Engine) PullQuery(ctx context.Context, nodeID ids.NodeID, requestID uint32, blkID ids.ID, requestedHeight uint64) error

func (*Engine) PushQuery

func (e *Engine) PushQuery(ctx context.Context, nodeID ids.NodeID, requestID uint32, blkBytes []byte, requestedHeight uint64) error

func (*Engine) Put

func (e *Engine) Put(ctx context.Context, nodeID ids.NodeID, requestID uint32, blkBytes []byte) error

func (*Engine) QueryFailed

func (e *Engine) QueryFailed(ctx context.Context, nodeID ids.NodeID, requestID uint32) error

func (*Engine) Shutdown

func (e *Engine) Shutdown(ctx context.Context) error

func (*Engine) Start

func (e *Engine) Start(ctx context.Context, startReqID uint32) error

func (*Engine) Timeout

func (*Engine) Timeout(context.Context) error