controller

Documentation

Overview

Package controller implements the DSNet network controller with testing capabilities. It manages node registrations, message forwarding, and network partitions. It also provides functions to manipulate message delivery according to testing configurations. These include dropping, duplicating, and reordering messages.

Index

• func Serve(cfg TestConfig)
• type Node
  • func (n *Node) SendEnvelope(env *pb.Envelope) error
• type Server
  • func NewServer(cfg TestConfig) *Server
  • func (s *Server) BlockCommunication(a, b string)
  • func (s *Server) CreatePartition(group1, group2 []string)
  • func (s *Server) Stream(stream pb.NetworkController_StreamServer) error
  • func (s *Server) UnblockCommunication(a, b string)
• type TestConfig
  • func (cfg *TestConfig) FillDefaults()

Functions

func Serve

func Serve(cfg TestConfig)

Serve starts the gRPC server for the DSNet controller with the given test configuration. Server listens on port 50051.

Types

type Node

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

Node represents a DSNet node that can send messages via the controller.

func (*Node) SendEnvelope

func (n *Node) SendEnvelope(env *pb.Envelope) error

SendEnvelope sends the given envelope via the node's gRPC stream.

type Server

type Server struct {
	pb.UnimplementedNetworkControllerServer
	// contains filtered or unexported fields
}

Server implements the DSNet network controller with testing capabilities.

func NewServer

func NewServer(cfg TestConfig) *Server

newServer creates a new DSNet controller server with the specified test configuration.

func (*Server) BlockCommunication

func (s *Server) BlockCommunication(a, b string)

BlockCommunication blocks messages from node a to node b.

func (*Server) CreatePartition

func (s *Server) CreatePartition(group1, group2 []string)

CreatePartition creates a partition between two groups of nodes. Nodes in group1 cannot communicate with nodes in group2 and vice versa.

func (*Server) Stream

func (s *Server) Stream(stream pb.NetworkController_StreamServer) error

Stream handles the bi-directional streaming RPC between the controller and a node.

func (*Server) UnblockCommunication

func (s *Server) UnblockCommunication(a, b string)

UnblockCommunication unblocks messages from node a to node b.

type TestConfig

type TestConfig struct {
	MsgDropProb          float64
	MsgDupeProb          float64
	AsyncDuplicate       bool
	DisableMessageDelays bool
	MsgMinDelay          int
	MsgMaxDelay          int

	//Network Spikes
	EnableNetworkSpikes bool
	NetSpikeSmallProb   float64
	NetSpikeMedProb     float64
	NetSpikeLargeProb   float64
}

TestConfig holds the configuration parameters for simulating network messaging conditions. These include probabilities for message drops, duplications, and reordering, as well as parameters for reordering delays.

func (*TestConfig) FillDefaults

func (cfg *TestConfig) FillDefaults()

FillDefaults fills in default values for TestConfig fields if they are not set.