mirror of
https://github.com/libp2p/go-libp2p.git
synced 2025-10-31 20:02:48 +08:00
104 lines
3.2 KiB
Go
104 lines
3.2 KiB
Go
// 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
|
|
package mocknet
|
|
|
|
import (
|
|
ic "github.com/ipfs/go-libp2p/p2p/crypto"
|
|
host "github.com/ipfs/go-libp2p/p2p/host"
|
|
inet "github.com/ipfs/go-libp2p/p2p/net"
|
|
peer "github.com/ipfs/go-libp2p/p2p/peer"
|
|
"io"
|
|
"time"
|
|
|
|
ma "QmbWxL1aXQhBjc1XGjGF1f2KGBMCBYSuT2ThA8YXnXJK83/go-multiaddr"
|
|
)
|
|
|
|
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)
|
|
AddPeerWithPeerstore(peer.ID, peer.Peerstore) (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
|
|
LinkAll() error
|
|
ConnectAllButSelf() error
|
|
}
|
|
|
|
// LinkOptions are used to change aspects of the links.
|
|
// Sorry but they dont work yet :(
|
|
type LinkOptions struct {
|
|
Latency time.Duration
|
|
Bandwidth float64 // in bytes-per-second
|
|
// we can make these values distributions down the road.
|
|
}
|
|
|
|
// 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 Link interface {
|
|
Networks() []inet.Network
|
|
Peers() []peer.ID
|
|
|
|
SetOptions(LinkOptions)
|
|
Options() LinkOptions
|
|
|
|
// Metrics() Metrics
|
|
}
|
|
|
|
// 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 LinkMap map[string]map[string]map[Link]struct{}
|
|
|
|
// Printer lets you inspect things :)
|
|
type Printer interface {
|
|
// MocknetLinks shows the entire Mocknet's link table :)
|
|
MocknetLinks(mn Mocknet)
|
|
NetworkConns(ni inet.Network)
|
|
}
|
|
|
|
// PrinterTo returns a Printer ready to write to w.
|
|
func PrinterTo(w io.Writer) Printer {
|
|
return &printer{w}
|
|
}
|