config

Documentation

Index

• Constants
• type Conf
  • func JSONConfig(path string) *Conf
  • func (c *Conf) WithParams(f func(c *Conf)) *Conf
• type Const
  • func NewConst(field string) Const
• type NodeConf
• type WGProgress
  • func NewWGProgress(start int) *WGProgress
  • func (p *WGProgress) Add()
  • func (p *WGProgress) Advance()
  • func (p *WGProgress) Progress(id string)

Constants

const AllNodesRun string = "AllNodesRun"

const Backlog string = "Backlog"

const Bias string = "Bias"

const ChokerStrategy string = "ChokerStrategy"

const InPeers string = "InPeers"

const Interval string = "Interval"

const LeaderPercent string = "LeaderPercent"

const MinNodes string = "MinNodes"

const Multi string = "Multi"

const Optimistics string = "Optimistics"

const OutPeers string = "OutPeers"

*

• Constant values to pass to "config.NewConst".

const PieceSize string = "PieceSize"

const Pieces string = "Pieces"

const Random string = "Random"

const Seeds string = "Seeds"

const StoragePieces string = "StoragePieces"

const TitForTat string = "TitForTat"

Choker strategies

const Uploads string = "Uploads"

Types

type Conf

type Conf struct {
	// BitTorrent
	OutPeers int `json:"outPeers"` // maximum number of outbound peers
	InPeers  int `json:"inPeers"`  // maximum number of inbound peers

	MinNodes int `json:"minNodes"` // minimum number of nodes in a Torrent
	Seeds    int `json:"seeds"`    // number of seed nodes

	PieceSize int `json:"pieceSize"` // the piece size
	Pieces    int `json:"pieces"`    // number of pieces in a Torrent

	Uploads int `json:"uploads"` // number of Uploads (without Optimistics)
	//   chosen by a Choker
	Optimistics int `json:"optimistics"` // number of Optimistics
	//   chosen by a Choker
	Interval int `json:"interval"` // milliseconds

	Backlog int `json:"backlog"` // number of pieces requested at a time

	// Extension
	LeaderPercent int `json:"leaderPercent"` // the percent of leaders in an AS

	// Biased Tracker extension
	Bias int `json:"bias"` // the number of connections to peers in different AS

	// Misc
	SharedCallback func()
	SharedInit     func()

	// Simulation parameters
	TransitDomains    int `json:"transitDomains"`
	TransitDomainSize int `json:"transitDomainSize"`
	StubDomains       int `json:"stubDomains"`
	StubDomainSize    int `json:"stubDomainSize"`

	TransferInterval int `json:"transferInterval"`

	CapacityNodes []NodeConf `json:"capacityNodes"`

	// Progress properties
	AllNodesRun         *WGProgress
	AllNodesRunInterval int `json:allNodesRunInterval`

	// Latency support
	Latency bool

	// Run the simulator's event queue with support for parallel events.
	Parallel bool

	// Multi-Torrent extension
	Multi         int
	StoragePieces int

	// Choker strategy(e.g. TitForTat, Random)
	ChokerStrategy string
}

var Config *Conf

func JSONConfig

func JSONConfig(path string) *Conf

func (*Conf) WithParams

func (c *Conf) WithParams(f func(c *Conf)) *Conf

Usage:

c := NewConf().
  WithParams(func(c *Conf) {
    c.OutPeers = 5
    c.MinNodes = 10
  })

type Const

type Const interface {
	Ref() interface{}
	Int() int
	String() string
}

func NewConst

func NewConst(field string) Const

*

• Usage:
• var c config.Const = config.NewConst(config.OutPeers)

type NodeConf

type NodeConf struct {
	Number   int `json:"number"`
	Upload   int `json:"upload"`
	Download int `json:"download"`
}

type WGProgress

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

func NewWGProgress

func NewWGProgress(start int) *WGProgress

func (*WGProgress) Add

func (p *WGProgress) Add()

func (*WGProgress) Advance

func (p *WGProgress) Advance()

func (*WGProgress) Progress

func (p *WGProgress) Progress(id string)