sender

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) Send(msg message.OutboundMessage, config common.SendConfig, subnetID ids.ID, ...) set.Set[ids.NodeID]
• type MockExternalSender
  • func NewMockExternalSender(ctrl *gomock.Controller) *MockExternalSender
  • func (m *MockExternalSender) EXPECT() *MockExternalSenderMockRecorder
  • func (m *MockExternalSender) Send(msg message.OutboundMessage, config common.SendConfig, subnetID ids.ID, ...) set.Set[ids.NodeID]
• type MockExternalSenderMockRecorder
  • func (mr *MockExternalSenderMockRecorder) Send(msg, config, subnetID, allower any) *gomock.Call

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,
	reg prometheus.Registerer,
) (common.Sender, error)

func Trace

func Trace(sender common.Sender, tracer trace.Tracer) common.Sender

Types

type ExternalSender

type ExternalSender interface {
	Send(
		msg message.OutboundMessage,
		config common.SendConfig,
		subnetID ids.ID,
		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 bool

	SendF func(msg message.OutboundMessage, config common.SendConfig, subnetID ids.ID, 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) Send

func (s *ExternalSenderTest) Send(
	msg message.OutboundMessage,
	config common.SendConfig,
	subnetID ids.ID,
	allower subnets.Allower,
) set.Set[ids.NodeID]

type MockExternalSender

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

MockExternalSender is a mock of ExternalSender interface.

func NewMockExternalSender

func NewMockExternalSender(ctrl *gomock.Controller) *MockExternalSender

NewMockExternalSender creates a new mock instance.

func (*MockExternalSender) EXPECT

func (m *MockExternalSender) EXPECT() *MockExternalSenderMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockExternalSender) Send

func (m *MockExternalSender) Send(msg message.OutboundMessage, config common.SendConfig, subnetID ids.ID, allower subnets.Allower) set.Set[ids.NodeID]

Send mocks base method.

type MockExternalSenderMockRecorder

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

MockExternalSenderMockRecorder is the mock recorder for MockExternalSender.

func (*MockExternalSenderMockRecorder) Send

func (mr *MockExternalSenderMockRecorder) Send(msg, config, subnetID, allower any) *gomock.Call

Send indicates an expected call of Send.