Add man to exported functions/fields

This commit is contained in:
Širhoe Biazhkovič
2021-11-27 00:26:53 +03:00
committed by Lawrence, Rendall
parent 0a5ac35c4d
commit 360ac9d08d
11 changed files with 72 additions and 32 deletions
+6 -2
View File
@@ -6,12 +6,15 @@ import (
"net"
)
// Pair - some key-value pair, used for BulkPut
type Pair struct {
Left, Right interface{}
}
// SerializedPeer concatenation of PeerID, net port and IP-address
type SerializedPeer string
// NewSerializedPeer builds SerializedPeer from bittorrent.Peer
func NewSerializedPeer(p bittorrent.Peer) SerializedPeer {
b := make([]byte, bittorrent.PeerIDLen+2+len(p.IP.IP))
copy(b[:bittorrent.PeerIDLen], p.ID[:])
@@ -21,13 +24,14 @@ func NewSerializedPeer(p bittorrent.Peer) SerializedPeer {
return SerializedPeer(b)
}
// ToPeer parses SerializedPeer to bittorrent.Peer
func (pk SerializedPeer) ToPeer() bittorrent.Peer {
peerId, err := bittorrent.NewPeerID([]byte(pk[:bittorrent.PeerIDLen]))
peerID, err := bittorrent.NewPeerID([]byte(pk[:bittorrent.PeerIDLen]))
if err != nil {
panic(err)
}
peer := bittorrent.Peer{
ID: peerId,
ID: peerID,
Port: binary.BigEndian.Uint16([]byte(pk[bittorrent.PeerIDLen : bittorrent.PeerIDLen+2])),
IP: bittorrent.IP{IP: net.IP(pk[bittorrent.PeerIDLen+2:])}}
+1
View File
@@ -452,6 +452,7 @@ func (bh *benchHolder) ScrapeSwarm1kInfohash(b *testing.B) {
})
}
// RunBenchmarks starts series of benchmarks
func RunBenchmarks(b *testing.B, newStorage benchStorageConstructor) {
bh := benchHolder{st: newStorage}
b.Run("BenchmarkNop", bh.Nop)
+6 -6
View File
@@ -7,7 +7,7 @@ import (
var (
testIh1, testIh2 bittorrent.InfoHash
testPeerId bittorrent.PeerID
testPeerID bittorrent.PeerID
testData []hashPeer
v4Peer, v6Peer bittorrent.Peer
)
@@ -15,18 +15,18 @@ var (
func init() {
testIh1, _ = bittorrent.NewInfoHash("00000000000000000001")
testIh2, _ = bittorrent.NewInfoHash("00000000000000000002")
testPeerId, _ = bittorrent.NewPeerID([]byte("00000000000000000001"))
testPeerID, _ = bittorrent.NewPeerID([]byte("00000000000000000001"))
testData = []hashPeer{
{
testIh1,
bittorrent.Peer{ID: testPeerId, Port: 1, IP: bittorrent.IP{IP: net.ParseIP("1.1.1.1").To4(), AddressFamily: bittorrent.IPv4}},
bittorrent.Peer{ID: testPeerID, Port: 1, IP: bittorrent.IP{IP: net.ParseIP("1.1.1.1").To4(), AddressFamily: bittorrent.IPv4}},
},
{
testIh2,
bittorrent.Peer{ID: testPeerId, Port: 2, IP: bittorrent.IP{IP: net.ParseIP("abab::0001"), AddressFamily: bittorrent.IPv6}},
bittorrent.Peer{ID: testPeerID, Port: 2, IP: bittorrent.IP{IP: net.ParseIP("abab::0001"), AddressFamily: bittorrent.IPv6}},
},
}
v4Peer = bittorrent.Peer{ID: testPeerId, IP: bittorrent.IP{IP: net.ParseIP("99.99.99.99").To4(), AddressFamily: bittorrent.IPv4}, Port: 9994}
v6Peer = bittorrent.Peer{ID: testPeerId, IP: bittorrent.IP{IP: net.ParseIP("fc00::0001"), AddressFamily: bittorrent.IPv6}, Port: 9996}
v4Peer = bittorrent.Peer{ID: testPeerID, IP: bittorrent.IP{IP: net.ParseIP("99.99.99.99").To4(), AddressFamily: bittorrent.IPv4}, Port: 9994}
v6Peer = bittorrent.Peer{ID: testPeerID, IP: bittorrent.IP{IP: net.ParseIP("fc00::0001"), AddressFamily: bittorrent.IPv6}, Port: 9996}
}