simulate

Documentation

Index

• func TestConnectivity(ctx context.Context, px0, px1 *Peer) error
• type Peer
  • func (p *Peer) Close()
  • func (p *Peer) GetInproc() *inproc.Inproc
  • func (p *Peer) GetLogger() *logrus.Entry
  • func (p *Peer) GetPeerID() bp.ID
  • func (p *Peer) GetPeerPriv() crypto.PrivKey
  • func (p *Peer) GetTestbed() *testbed.Testbed
  • func (p *Peer) GetTransportController() *transport_controller.Controller
• type Simulator
  • func NewSimulator(ctx context.Context, le *logrus.Entry, grp *graph.Graph, ...) (*Simulator, error)
  • func (s *Simulator) Close()
  • func (s *Simulator) GetPeerByID(id bpeer.ID) *Peer
• type SimulatorOption
  • func WithVerbose() SimulatorOption

Functions

func TestConnectivity

func TestConnectivity(ctx context.Context, px0, px1 *Peer) error

TestConnectivity tests for basic connectivity between two peers. Uses an echo test: dials the Echo controller.

Types

type Peer

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

Peer holds state about an executing Peer

func (*Peer) Close

func (p *Peer) Close()

Close cancels the Peer's subroutines.

func (*Peer) GetInproc

func (p *Peer) GetInproc() *inproc.Inproc

GetInproc returns the in-proc transport.

func (*Peer) GetLogger

func (p *Peer) GetLogger() *logrus.Entry

GetLogger returns the logger for the peer.

func (*Peer) GetPeerID

func (p *Peer) GetPeerID() bp.ID

GetPeerID returns the Peer ID.

func (*Peer) GetPeerPriv

func (p *Peer) GetPeerPriv() crypto.PrivKey

GetPeerPriv returns the Peer private key.

func (*Peer) GetTestbed

func (p *Peer) GetTestbed() *testbed.Testbed

GetTestbed returns the testbed.

func (*Peer) GetTransportController

func (p *Peer) GetTransportController() *transport_controller.Controller

GetTransportController returns the transport controller.

type Simulator

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

Simulator manages state for all simulated machines.

func NewSimulator

func NewSimulator(
	ctx context.Context,
	le *logrus.Entry,
	grp *graph.Graph,
	opts ...SimulatorOption,
) (*Simulator, error)

NewSimulator constructs a new sim.

func (*Simulator) Close

func (s *Simulator) Close()

Close closes the simulator.

func (*Simulator) GetPeerByID

func (s *Simulator) GetPeerByID(id bpeer.ID) *Peer

GetPeerByID returns a peer by ID.

type SimulatorOption

type SimulatorOption func(s *Simulator) error

SimulatorOption is an option passed to NewSimulator.

func WithVerbose

func WithVerbose() SimulatorOption

WithVerbose enables verbose logging.