Documentation
¶
Overview ¶
Package mocknet provides a mock net.Network to test with.
- a Mocknet has many inet.Networks - a Mocknet has many Links - a Link joins two inet.Networks - inet.Conns and inet.Streams are created by inet.Networks
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Link ¶
type Link interface {
Networks() []inet.Network
Peers() []peer.ID
SetOptions(LinkOptions)
Options() LinkOptions
}
Link represents the **possibility** of a connection between two peers. Think of it like physical network links. Without them, the peers can try and try but they won't be able to connect. This allows constructing topologies where specific nodes cannot talk to each other directly. :)
type LinkMap ¶
type LinkMap map[string]map[string]map[Link]struct{}
LinkMap is a 3D map to give us an easy way to track links. (wow, much map. so data structure. how compose. ahhh pointer)
type LinkOptions ¶
type LinkOptions struct {
Latency time.Duration
Bandwidth int // in bytes-per-second
}
LinkOptions are used to change aspects of the links. Sorry but they dont work yet :(
type Mocknet ¶
type Mocknet interface {
// GenPeer generates a peer and its inet.Network in the Mocknet
GenPeer() (host.Host, error)
// AddPeer adds an existing peer. we need both a privkey and addr.
// ID is derived from PrivKey
AddPeer(ic.PrivKey, ma.Multiaddr) (host.Host, error)
// retrieve things (with randomized iteration order)
Peers() []peer.ID
Net(peer.ID) inet.Network
Nets() []inet.Network
Host(peer.ID) host.Host
Hosts() []host.Host
Links() LinkMap
LinksBetweenPeers(a, b peer.ID) []Link
LinksBetweenNets(a, b inet.Network) []Link
// Links are the **ability to connect**.
// think of Links as the physical medium.
// For p1 and p2 to connect, a link must exist between them.
// (this makes it possible to test dial failures, and
// things like relaying traffic)
LinkPeers(peer.ID, peer.ID) (Link, error)
LinkNets(inet.Network, inet.Network) (Link, error)
Unlink(Link) error
UnlinkPeers(peer.ID, peer.ID) error
UnlinkNets(inet.Network, inet.Network) error
// LinkDefaults are the default options that govern links
// if they do not have thier own option set.
SetLinkDefaults(LinkOptions)
LinkDefaults() LinkOptions
// Connections are the usual. Connecting means Dialing.
// **to succeed, peers must be linked beforehand**
ConnectPeers(peer.ID, peer.ID) (inet.Conn, error)
ConnectNets(inet.Network, inet.Network) (inet.Conn, error)
DisconnectPeers(peer.ID, peer.ID) error
DisconnectNets(inet.Network, inet.Network) error
}
func FullMeshConnected ¶
func FullMeshConnected(ctx context.Context, n int) (Mocknet, error)
FullMeshConnected constructs a Mocknet with full mesh of Connections. This means that all the peers have dialed and are ready to talk to each other.
func FullMeshLinked ¶
func FullMeshLinked(ctx context.Context, n int) (Mocknet, error)
FullMeshLinked constructs a Mocknet with full mesh of Links. This means that all the peers **can** connect to each other (not that they already are connected. you can use m.ConnectAll())
func WithNPeers ¶
func WithNPeers(ctx context.Context, n int) (Mocknet, error)
WithNPeers constructs a Mocknet with N peers.
Source Files