router

package
v1.6.0-rc.6 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 16, 2021 License: BSD-3-Clause Imports: 25 Imported by: 37

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AppRouter added in v1.5.3 

type AppRouter interface {
	AppRequest(
		nodeID ids.ShortID,
		chainID ids.ID,
		requestID uint32,
		deadline time.Time,
		appRequestBytes []byte,
		onFinishedHandling func(),
	)
	AppResponse(
		nodeID ids.ShortID,
		chainID ids.ID,
		requestID uint32,
		appResponseBytes []byte,
		onFinishedHandling func(),
	)
	AppGossip(
		nodeID ids.ShortID,
		chainID ids.ID,
		appGossipBytes []byte,
		onFinishedHandling func(),
	)
}

AppRouter routes app-level messages

type ChainRouter 

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

ChainRouter routes incoming messages from the validator network to the consensus engines that the messages are intended for. Note that consensus engines are uniquely identified by the ID of the chain that they are working on.

func (*ChainRouter) Accepted 

func (cr *ChainRouter) Accepted(
	validatorID ids.ShortID,
	chainID ids.ID,
	requestID uint32,
	containerIDs []ids.ID,
	onFinishedHandling func(),
)

Accepted routes an incoming Accepted request from the validator with ID [validatorID] to the consensus engine working on the chain with ID [chainID]

func (*ChainRouter) AcceptedFrontier 

func (cr *ChainRouter) AcceptedFrontier(
	validatorID ids.ShortID,
	chainID ids.ID,
	requestID uint32,
	containerIDs []ids.ID,
	onFinishedHandling func(),
)

AcceptedFrontier routes an incoming AcceptedFrontier request from the validator with ID [validatorID] to the consensus engine working on the chain with ID [chainID]

func (*ChainRouter) AddChain 

func (cr *ChainRouter) AddChain(chain *Handler)

AddChain registers the specified chain so that incoming messages can be routed to it

func (*ChainRouter) AppGossip added in v1.5.3 

func (cr *ChainRouter) AppGossip(
	nodeID ids.ShortID,
	chainID ids.ID,
	appGossipBytes []byte,
	onFinishedHandling func(),
)

AppGossip routes an incoming application-level gossip message from the given node to the consensus engine working on the given chain

func (*ChainRouter) AppRequest added in v1.5.3 

func (cr *ChainRouter) AppRequest(
	nodeID ids.ShortID,
	chainID ids.ID,
	requestID uint32,
	deadline time.Time,
	appRequestBytes []byte,
	onFinishedHandling func(),
)

AppRequest routes an incoming application-level request from the given node to the consensus engine working on the given chain

func (*ChainRouter) AppRequestFailed added in v1.5.3 

func (cr *ChainRouter) AppRequestFailed(nodeID ids.ShortID, chainID ids.ID, requestID uint32)

AppRequestFailed notifies the given chain that it will not receive a response to its request with the given ID to the given node.

func (*ChainRouter) AppResponse added in v1.5.3 

func (cr *ChainRouter) AppResponse(
	nodeID ids.ShortID,
	chainID ids.ID,
	requestID uint32,
	appResponseBytes []byte,
	onFinishedHandling func(),
)

AppResponse routes an incoming application-level response from the given node to the consensus engine working on the given chain

func (*ChainRouter) Benched added in v1.4.3 

func (cr *ChainRouter) Benched(chainID ids.ID, validatorID ids.ShortID)

Benched routes an incoming notification that a validator was benched

func (*ChainRouter) Chits 

func (cr *ChainRouter) Chits(
	validatorID ids.ShortID,
	chainID ids.ID,
	requestID uint32,
	votes []ids.ID,
	onFinishedHandling func(),
)

Chits routes an incoming Chits message from the validator with ID [validatorID] to the consensus engine working on the chain with ID [chainID]

func (*ChainRouter) Connected added in v0.8.2 

func (cr *ChainRouter) Connected(validatorID ids.ShortID)

Connected routes an incoming notification that a validator was just connected

func (*ChainRouter) Disconnected added in v0.8.2 

func (cr *ChainRouter) Disconnected(validatorID ids.ShortID)

Disconnected routes an incoming notification that a validator was connected

func (*ChainRouter) EndInterval added in v0.8.0 

func (cr *ChainRouter) EndInterval()

EndInterval notifies the chains that the current CPU interval has ended TODO remove?

func (*ChainRouter) Get 

func (cr *ChainRouter) Get(
	validatorID ids.ShortID,
	chainID ids.ID,
	requestID uint32,
	deadline time.Time,
	containerID ids.ID,
	onFinishedHandling func(),
)

Get routes an incoming Get request from the validator with ID [validatorID] to the consensus engine working on the chain with ID [chainID]

func (*ChainRouter) GetAccepted 

func (cr *ChainRouter) GetAccepted(
	validatorID ids.ShortID,
	chainID ids.ID,
	requestID uint32,
	deadline time.Time,
	containerIDs []ids.ID,
	onFinishedHandling func(),
)

GetAccepted routes an incoming GetAccepted request from the validator with ID [validatorID] to the consensus engine working on the chain with ID [chainID]

func (*ChainRouter) GetAcceptedFailed 

func (cr *ChainRouter) GetAcceptedFailed(
	validatorID ids.ShortID,
	chainID ids.ID,
	requestID uint32,
)

GetAcceptedFailed routes an incoming GetAcceptedFailed request from the validator with ID [validatorID] to the consensus engine working on the chain with ID [chainID]

func (*ChainRouter) GetAcceptedFrontier 

func (cr *ChainRouter) GetAcceptedFrontier(
	validatorID ids.ShortID,
	chainID ids.ID,
	requestID uint32,
	deadline time.Time,
	onFinishedHandling func(),
)

GetAcceptedFrontier routes an incoming GetAcceptedFrontier request from the validator with ID [validatorID] to the consensus engine working on the chain with ID [chainID]

func (*ChainRouter) GetAcceptedFrontierFailed 

func (cr *ChainRouter) GetAcceptedFrontierFailed(
	validatorID ids.ShortID,
	chainID ids.ID,
	requestID uint32,
)

GetAcceptedFrontierFailed routes an incoming GetAcceptedFrontierFailed request from the validator with ID [validatorID] to the consensus engine working on the chain with ID [chainID]

func (*ChainRouter) GetAncestors added in v0.8.0 

func (cr *ChainRouter) GetAncestors(
	validatorID ids.ShortID,
	chainID ids.ID,
	requestID uint32,
	deadline time.Time,
	containerID ids.ID,
	onFinishedHandling func(),
)

GetAncestors routes an incoming GetAncestors message from the validator with ID [validatorID] to the consensus engine working on the chain with ID [chainID] The maximum number of ancestors to respond with is defined in snow/engine/common/bootstrapper.go

func (*ChainRouter) GetAncestorsFailed added in v0.8.0 

func (cr *ChainRouter) GetAncestorsFailed(
	validatorID ids.ShortID,
	chainID ids.ID,
	requestID uint32,
)

GetAncestorsFailed routes an incoming GetAncestorsFailed message from the validator with ID [validatorID] to the consensus engine working on the chain with ID [chainID]

func (*ChainRouter) GetFailed 

func (cr *ChainRouter) GetFailed(
	validatorID ids.ShortID,
	chainID ids.ID,
	requestID uint32,
)

GetFailed routes an incoming GetFailed message from the validator with ID [validatorID] to the consensus engine working on the chain with ID [chainID]

func (*ChainRouter) Gossip added in v0.8.0 

func (cr *ChainRouter) Gossip()

Gossip accepted containers

func (*ChainRouter) HealthCheck added in v1.2.1 

func (cr *ChainRouter) HealthCheck() (interface{}, error)

HealthCheck returns results of router health checks. Returns: 1) Information about health check results 2) An error if the health check reports unhealthy

func (*ChainRouter) Initialize 

func (cr *ChainRouter) Initialize(
	nodeID ids.ShortID,
	log logging.Logger,
	timeoutManager *timeout.Manager,
	gossipFrequency time.Duration,
	closeTimeout time.Duration,
	criticalChains ids.Set,
	onFatal func(exitCode int),
	healthConfig HealthConfig,
	metricsNamespace string,
	metricsRegisterer prometheus.Registerer,
) error

Initialize the router.

When this router receives an incoming message, it cancels the timeout in [timeouts] associated with the request that caused the incoming message, if applicable.

This router also fires a gossip event every [gossipFrequency] to the engine, notifying the engine it should gossip it's accepted set.

func (*ChainRouter) MultiPut added in v0.8.0 

func (cr *ChainRouter) MultiPut(
	validatorID ids.ShortID,
	chainID ids.ID,
	requestID uint32,
	containers [][]byte,
	onFinishedHandling func(),
)

MultiPut routes an incoming MultiPut message from the validator with ID [validatorID] to the consensus engine working on the chain with ID [chainID]

func (*ChainRouter) PullQuery 

func (cr *ChainRouter) PullQuery(
	validatorID ids.ShortID,
	chainID ids.ID,
	requestID uint32,
	deadline time.Time,
	containerID ids.ID,
	onFinishedHandling func(),
)

PullQuery routes an incoming PullQuery request from the validator with ID [validatorID] to the consensus engine working on the chain with ID [chainID]

func (*ChainRouter) PushQuery 

func (cr *ChainRouter) PushQuery(
	validatorID ids.ShortID,
	chainID ids.ID,
	requestID uint32,
	deadline time.Time,
	containerID ids.ID,
	container []byte,
	onFinishedHandling func(),
)

PushQuery routes an incoming PushQuery request from the validator with ID [validatorID] to the consensus engine working on the chain with ID [chainID]

func (*ChainRouter) Put 

func (cr *ChainRouter) Put(
	validatorID ids.ShortID,
	chainID ids.ID,
	requestID uint32,
	containerID ids.ID,
	container []byte,
	onFinishedHandling func(),
)

Put routes an incoming Put request from the validator with ID [validatorID] to the consensus engine working on the chain with ID [chainID]

func (*ChainRouter) QueryFailed 

func (cr *ChainRouter) QueryFailed(
	validatorID ids.ShortID,
	chainID ids.ID,
	requestID uint32,
)

QueryFailed routes an incoming QueryFailed message from the validator with ID [validatorID] to the consensus engine working on the chain with ID [chainID]

func (*ChainRouter) RegisterRequest added in v1.2.1 

func (cr *ChainRouter) RegisterRequest(
	nodeID ids.ShortID,
	chainID ids.ID,
	requestID uint32,
	msgType constants.MsgType,
)

RegisterRequest marks that we should expect to receive a reply from the given validator regarding the given chain and the reply should have the given requestID. The type of message we sent the validator was [msgType]. Every registered request must be cleared either by receiving a valid reply and passing it to the appropriate chain or by a call to GetFailed, GetAncestorsFailed, etc. This method registers a timeout that calls such methods if we don't get a reply in time.

func (*ChainRouter) Shutdown 

func (cr *ChainRouter) Shutdown()

Shutdown shuts down this router

func (*ChainRouter) Unbenched added in v1.4.3 

func (cr *ChainRouter) Unbenched(chainID ids.ID, validatorID ids.ShortID)

Unbenched routes an incoming notification that a validator was just unbenched

type ExternalRouter 

type ExternalRouter interface {
	AppRouter
	RegisterRequest(
		nodeID ids.ShortID,
		chainID ids.ID,
		requestID uint32,
		msgType constants.MsgType,
	)
	GetAcceptedFrontier(
		nodeID ids.ShortID,
		chainID ids.ID,
		requestID uint32,
		deadline time.Time,
		onFinishedHandling func(),
	)
	AcceptedFrontier(
		nodeID ids.ShortID,
		chainID ids.ID,
		requestID uint32,
		containerIDs []ids.ID,
		onFinishedHandling func(),
	)
	GetAccepted(
		nodeID ids.ShortID,
		chainID ids.ID,
		requestID uint32,
		deadline time.Time,
		containerIDs []ids.ID,
		onFinishedHandling func(),
	)
	Accepted(
		nodeID ids.ShortID,
		chainID ids.ID,
		requestID uint32,
		containerIDs []ids.ID,
		onFinishedHandling func(),
	)
	GetAncestors(
		nodeID ids.ShortID,
		chainID ids.ID,
		requestID uint32,
		deadline time.Time,
		containerID ids.ID,
		onFinishedHandling func(),
	)
	MultiPut(
		nodeID ids.ShortID,
		chainID ids.ID,
		requestID uint32,
		containers [][]byte,
		onFinishedHandling func(),
	)
	Get(
		nodeID ids.ShortID,
		chainID ids.ID,
		requestID uint32,
		deadline time.Time,
		containerID ids.ID,
		onFinishedHandling func(),
	)
	Put(
		nodeID ids.ShortID,
		chainID ids.ID,
		requestID uint32,
		containerID ids.ID,
		container []byte,
		onFinishedHandling func(),
	)
	PushQuery(
		nodeID ids.ShortID,
		chainID ids.ID,
		requestID uint32,
		deadline time.Time,
		containerID ids.ID,
		container []byte,
		onFinishedHandling func(),
	)
	PullQuery(
		nodeID ids.ShortID,
		chainID ids.ID,
		requestID uint32,
		deadline time.Time,
		containerID ids.ID,
		onFinishedHandling func(),
	)
	Chits(
		nodeID ids.ShortID,
		chainID ids.ID,
		requestID uint32,
		votes []ids.ID,
		onFinishedHandling func(),
	)
}

ExternalRouter routes messages from the network to the Handler of the consensus engine that the message is intended for

type Handler added in v0.8.0 

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

Handler passes incoming messages from the network to the consensus engine. (Actually, it receives the incoming messages from a ChainRouter, but same difference.)

func (*Handler) Accepted added in v0.8.0 

func (h *Handler) Accepted(
	nodeID ids.ShortID,
	requestID uint32,
	containerIDs []ids.ID,
	onDoneHandling func(),
)

Accepted passes a Accepted message received from the network to the consensus engine.

func (*Handler) AcceptedFrontier added in v0.8.0 

func (h *Handler) AcceptedFrontier(
	nodeID ids.ShortID,
	requestID uint32,
	containerIDs []ids.ID,
	onDoneHandling func(),
)

AcceptedFrontier passes a AcceptedFrontier message received from the network to the consensus engine.

func (*Handler) AppGossip added in v1.5.3 

func (h *Handler) AppGossip(nodeID ids.ShortID, appGossipBytes []byte, onFinishedHandling func())

AppGossip passes an application-level gossip message from the given node to the consensus engine.

func (*Handler) AppRequest added in v1.5.3 

func (h *Handler) AppRequest(nodeID ids.ShortID, requestID uint32, deadline time.Time, appRequestBytes []byte, onFinishedHandling func())

AppRequest passes an application-level request from the given node to the consensus engine.

func (*Handler) AppRequestFailed added in v1.5.3 

func (h *Handler) AppRequestFailed(nodeID ids.ShortID, requestID uint32)

AppRequestFailed notifies the consensus engine that an application-level request failed and it won't receive a response to the request.

func (*Handler) AppResponse added in v1.5.3 

func (h *Handler) AppResponse(nodeID ids.ShortID, requestID uint32, appResponseBytes []byte, onFinishedHandling func())

AppResponse passes an application-level response from the given node to the consensus engine.

func (*Handler) Chits added in v0.8.0 

func (h *Handler) Chits(nodeID ids.ShortID, requestID uint32, votes []ids.ID, onDoneHandling func())

Chits passes a Chits message received from the network to the consensus engine.

func (*Handler) Connected added in v0.8.2 

func (h *Handler) Connected(nodeID ids.ShortID)

Connected passes a new connection notification to the consensus engine

func (*Handler) Context added in v0.8.0 

func (h *Handler) Context() *snow.Context

Context of this Handler

func (*Handler) Disconnected added in v0.8.2 

func (h *Handler) Disconnected(nodeID ids.ShortID)

Disconnected passes a new connection notification to the consensus engine

func (*Handler) Dispatch added in v0.8.0 

func (h *Handler) Dispatch()

Dispatch waits for incoming messages from the router and, when they arrive, sends them to the consensus engine

func (*Handler) Engine added in v0.8.0 

func (h *Handler) Engine() common.Engine

Engine returns the engine this handler dispatches to

func (*Handler) Get added in v0.8.0 

func (h *Handler) Get(
	nodeID ids.ShortID,
	requestID uint32,
	deadline time.Time,
	containerID ids.ID,
	onDoneHandling func(),
)

Get passes a Get message received from the network to the consensus engine.

func (*Handler) GetAccepted added in v0.8.0 

func (h *Handler) GetAccepted(
	nodeID ids.ShortID,
	requestID uint32,
	deadline time.Time,
	containerIDs []ids.ID,
	onDoneHandling func(),
)

GetAccepted passes a GetAccepted message received from the network to the consensus engine.

func (*Handler) GetAcceptedFailed added in v0.8.0 

func (h *Handler) GetAcceptedFailed(nodeID ids.ShortID, requestID uint32)

GetAcceptedFailed passes a GetAcceptedFailed message received from the network to the consensus engine.

func (*Handler) GetAcceptedFrontier added in v0.8.0 

func (h *Handler) GetAcceptedFrontier(
	nodeID ids.ShortID,
	requestID uint32,
	deadline time.Time,
	onDoneHandling func(),
)

GetAcceptedFrontier passes a GetAcceptedFrontier message received from the network to the consensus engine.

func (*Handler) GetAcceptedFrontierFailed added in v0.8.0 

func (h *Handler) GetAcceptedFrontierFailed(nodeID ids.ShortID, requestID uint32)

GetAcceptedFrontierFailed passes a GetAcceptedFrontierFailed message received from the network to the consensus engine.

func (*Handler) GetAncestors added in v0.8.0 

func (h *Handler) GetAncestors(
	nodeID ids.ShortID,
	requestID uint32,
	deadline time.Time,
	containerID ids.ID,
	onDoneHandling func(),
)

GetAncestors passes a GetAncestors message received from the network to the consensus engine.

func (*Handler) GetAncestorsFailed added in v0.8.0 

func (h *Handler) GetAncestorsFailed(nodeID ids.ShortID, requestID uint32)

GetAncestorsFailed passes a GetAncestorsFailed message to the consensus engine.

func (*Handler) GetFailed added in v0.8.0 

func (h *Handler) GetFailed(nodeID ids.ShortID, requestID uint32)

GetFailed passes a GetFailed message to the consensus engine.

func (*Handler) Gossip added in v0.8.0 

func (h *Handler) Gossip()

Gossip passes a gossip request to the consensus engine

func (*Handler) Initialize added in v0.8.0 

func (h *Handler) Initialize(
	engine common.Engine,
	validators validators.Set,
	msgFromVMChan <-chan common.Message,
	metricsNamespace string,
	metricsRegisterer prometheus.Registerer,
) error

Initialize this consensus handler [engine] must be initialized before initializing this handler

func (*Handler) MultiPut added in v0.8.0 

func (h *Handler) MultiPut(
	nodeID ids.ShortID,
	requestID uint32,
	containers [][]byte,
	onDoneHandling func(),
)

MultiPut passes a MultiPut message received from the network to the consensus engine.

func (*Handler) PullQuery added in v0.8.0 

func (h *Handler) PullQuery(
	nodeID ids.ShortID,
	requestID uint32,
	deadline time.Time,
	containerID ids.ID,
	onDoneHandling func(),
)

PullQuery passes a PullQuery message received from the network to the consensus engine.

func (*Handler) PushQuery added in v0.8.0 

func (h *Handler) PushQuery(
	nodeID ids.ShortID,
	requestID uint32,
	deadline time.Time,
	containerID ids.ID,
	container []byte,
	onDoneHandling func(),
)

PushQuery passes a PushQuery message received from the network to the consensus engine.

func (*Handler) Put added in v0.8.0 

func (h *Handler) Put(
	nodeID ids.ShortID,
	requestID uint32,
	containerID ids.ID,
	container []byte,
	onDoneHandling func(),
)

Put passes a Put message received from the network to the consensus engine.

func (*Handler) QueryFailed added in v0.8.0 

func (h *Handler) QueryFailed(nodeID ids.ShortID, requestID uint32)

QueryFailed passes a QueryFailed message received from the network to the consensus engine.

func (*Handler) SetEngine added in v0.8.0 

func (h *Handler) SetEngine(engine common.Engine)

SetEngine sets the engine for this handler to dispatch to

func (*Handler) StartShutdown added in v1.4.10 

func (h *Handler) StartShutdown()

StartShutdown starts the shutdown process for this handler/engine. [h] must never be invoked again after calling this method. This method causes [shutdown] to eventually be called. [h.closed] is closed when this handler/engine are done shutting down.

func (*Handler) Timeout added in v1.4.4 

func (h *Handler) Timeout()

Timeout passes a new timeout notification to the consensus engine

type HealthConfig added in v1.2.1 

type HealthConfig struct {
	// Reports unhealthy if we drop more than [MaxDropRate] of messages
	MaxDropRate float64 `json:"maxDropRate"`

	// Halflife of averager used to calculate the message drop rate
	// Must be > 0.
	// Larger value --> Drop rate affected less by recent messages
	MaxDropRateHalflife time.Duration `json:"maxDropRateHalflife"`

	// Reports unhealthy if more than this number of requests are outstanding.
	// Must be > 0
	MaxOutstandingRequests int `json:"maxOutstandingRequests"`

	// Reports unhealthy if there is a request outstanding for longer than this
	MaxOutstandingDuration time.Duration `json:"maxOutstandingDuration"`

	// Reports unhealthy if there is at least 1 outstanding not processed
	// before this mark
	MaxRunTimeRequests time.Duration `json:"maxRunTimeRequests"`
}

HealthConfig describes parameters for router health checks.

type InternalRouter 

type InternalRouter interface {
	benchlist.Benchable

	GetAcceptedFrontierFailed(nodeID ids.ShortID, chainID ids.ID, requestID uint32)
	GetAcceptedFailed(nodeID ids.ShortID, chainID ids.ID, requestID uint32)
	GetFailed(nodeID ids.ShortID, chainID ids.ID, requestID uint32)
	GetAncestorsFailed(nodeID ids.ShortID, chainID ids.ID, requestID uint32)
	QueryFailed(nodeID ids.ShortID, chainID ids.ID, requestID uint32)

	AppRequestFailed(nodeID ids.ShortID, chainID ids.ID, requestID uint32)

	Connected(nodeID ids.ShortID)
	Disconnected(nodeID ids.ShortID)
}

InternalRouter deals with messages internal to this node

type Router 

type Router interface {
	ExternalRouter
	InternalRouter

	Initialize(
		nodeID ids.ShortID,
		log logging.Logger,
		timeouts *timeout.Manager,
		gossipFrequency,
		shutdownTimeout time.Duration,
		criticalChains ids.Set,
		onFatal func(exitCode int),
		healthConfig HealthConfig,
		metricsNamespace string,
		metricsRegisterer prometheus.Registerer,
	) error
	Shutdown()
	AddChain(chain *Handler)
	health.Checkable
}

Router routes consensus messages to the Handler of the consensus engine that the messages are intended for

type Timer added in v1.4.4 

type Timer struct {
	Handler *Handler
	Preempt chan struct{}
}

func (*Timer) RegisterTimeout added in v1.4.4 

func (t *Timer) RegisterTimeout(d time.Duration)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.