Documentation
¶
Overview ¶
Package sender is a generated GoMock package.
Index ¶
- func New(ctx *snow.ConsensusContext, msgCreator message.OutboundMsgBuilder, ...) (common.Sender, error)
- func Trace(sender common.Sender, tracer trace.Tracer) common.Sender
- type ExternalSender
- type ExternalSenderTest
- func (s *ExternalSenderTest) Default(cant bool)
- func (s *ExternalSenderTest) Gossip(msg message.OutboundMessage, subnetID ids.ID, numValidatorsToSend int, ...) set.Set[ids.NodeID]
- func (s *ExternalSenderTest) Send(msg message.OutboundMessage, nodeIDs set.Set[ids.NodeID], subnetID ids.ID, ...) set.Set[ids.NodeID]
- type MockExternalSender
- func (m *MockExternalSender) EXPECT() *MockExternalSenderMockRecorder
- func (m *MockExternalSender) Gossip(msg message.OutboundMessage, subnetID ids.ID, ...) set.Set[ids.NodeID]
- func (m *MockExternalSender) Send(msg message.OutboundMessage, nodeIDs set.Set[ids.NodeID], subnetID ids.ID, ...) set.Set[ids.NodeID]
- type MockExternalSenderMockRecorder
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func New ¶
func New( ctx *snow.ConsensusContext, msgCreator message.OutboundMsgBuilder, externalSender ExternalSender, router router.Router, timeouts timeout.Manager, engineType p2p.EngineType, subnet subnets.Subnet, ) (common.Sender, error)
Types ¶
type ExternalSender ¶
type ExternalSender interface {
// Send a message to a specific set of nodes
Send(
msg message.OutboundMessage,
nodeIDs set.Set[ids.NodeID],
subnetID ids.ID,
allower subnets.Allower,
) set.Set[ids.NodeID]
// Send a message to a random group of nodes in a subnet.
// Nodes are sampled based on their validator status.
Gossip(
msg message.OutboundMessage,
subnetID ids.ID,
numValidatorsToSend int,
numNonValidatorsToSend int,
numPeersToSend int,
allower subnets.Allower,
) set.Set[ids.NodeID]
}
ExternalSender sends consensus messages to other validators Right now this is implemented in the networking package
type ExternalSenderTest ¶
type ExternalSenderTest struct {
TB testing.TB
CantSend, CantGossip bool
SendF func(msg message.OutboundMessage, nodeIDs set.Set[ids.NodeID], subnetID ids.ID, allower subnets.Allower) set.Set[ids.NodeID]
GossipF func(msg message.OutboundMessage, subnetID ids.ID, numValidatorsToSend, numNonValidatorsToSend, numPeersToSend int, allower subnets.Allower) set.Set[ids.NodeID]
}
ExternalSenderTest is a test sender
func (*ExternalSenderTest) Default ¶
func (s *ExternalSenderTest) Default(cant bool)
Default set the default callable value to [cant]
func (*ExternalSenderTest) Gossip ¶
func (s *ExternalSenderTest) Gossip( msg message.OutboundMessage, subnetID ids.ID, numValidatorsToSend int, numNonValidatorsToSend int, numPeersToSend int, allower subnets.Allower, ) set.Set[ids.NodeID]
Given a msg type, the corresponding mock function is called if it was initialized. If it wasn't initialized and this function shouldn't be called and testing was initialized, then testing will fail.
type MockExternalSender ¶ added in v1.9.4
type MockExternalSender struct {
// contains filtered or unexported fields
}
MockExternalSender is a mock of ExternalSender interface.
func NewMockExternalSender ¶ added in v1.9.4
func NewMockExternalSender(ctrl *gomock.Controller) *MockExternalSender
NewMockExternalSender creates a new mock instance.
func (*MockExternalSender) EXPECT ¶ added in v1.9.4
func (m *MockExternalSender) EXPECT() *MockExternalSenderMockRecorder
EXPECT returns an object that allows the caller to indicate expected use.
type MockExternalSenderMockRecorder ¶ added in v1.9.4
type MockExternalSenderMockRecorder struct {
// contains filtered or unexported fields
}
MockExternalSenderMockRecorder is the mock recorder for MockExternalSender.
Source Files
Click to show internal directories.
Click to hide internal directories.