Q2P 是一个基于 UDP 协议实现的点对点（P2P）网络通信库，旨在通过简单的网络事件驱动和数据传输协议，支持多个节点之间的连接和数据交换。该库采用 Go 语言编写，提供了一种简洁的方式来实现 P2P 网络中的设备连接、通信和数据传输。
Q2P 分为协议层和传输层：协议层、传输层
Q 代表 quick，因为其传输层的实现方式与特性与 QUIC 协议很相似
- 网络事件驱动：支持多种网络事件（如连接请求、数据传输等）处理。
- 点对点通信：基于 UDP 协议进行高效的数据传输和节点间连接。
- 可靠的连接管理：通过事件机制实现节点间的连接请求、连接确认等过程。
- 数据分片传输：支持大数据量的分片传输，并在传输失败时进行重试。
- 传输超时控制：支持传输过程中的超时检测和失败处理。
- Go 1.22
go get github.com/mosalut/q2p假使已知一个种子节点在127.0.0.1:10000启动
package main
import (
"github.com/mosalut/q2p"
"log"
)
/* 自定义回调函数
peer *Peer_T // 当前peer
rAddr *net.UDPAddr // 发送方地址
key string // Transmission HASH
data []byte // 接收到的完整数据
*/
func callback(peer *Peer_T, rAddr *net.UDPAddr, key string, data []byte) {
fmt.Println(key) // key是本次传输的hash
fmt.Println(string(data))
}
/* 自定义transport失败时的回调函数
peer *Peer_T // 当前peer
rAddr *net.UDPAddr // 发送方地址
key string // Transmission HASH
syns []uint32 // 丢包的SYN位置列表
*/
func callbackFailed(peer *q2p.Peer_T, rAddr *net.UDPAddr, key string, syns []uint32) { // rAddr为发送TRANSPORT_FAILED那一方节点的UDP地址，也是接收TRANSPORT事件的地址
fmt.Println(key) // key是失败的传输的hash
fmt.Println(syns []uint32) // 丢失的那些数据包的SYN
}
func main() {
seedAddrs = make(map[string]bool)
seedAddrs[127.0.0.1:10000] = false // 将已知种子节点放入seedAddrs
// 创建新节点
// 参数列表:
// ip string 节点启动的主机地址 默认为 0.0.0.0
// port int 节点启动的主机端口 默认为 10000
// rAddrs map[string]bool 种子节点列表 默认为空
// networkID uint16 网络号 与其他Q2P网络隔离
// timeSendAgain 接收方隔多久检查一次是否有丢包 如果有丢包会告知发送方
// timeout int 接收方等到完整数据的超时时间 如果超时会告知发送方
// callback func(*Peer_T, *net.UDPAddr, string, []byte) 接收到完整数据时执行的回调函数
// callbackFailed func(*Peer_T, *net.UDPAddr, string, []uint32) 接收到失败时的回调函数 如果最后一个参数的长度为0 表示超时 否则代表丢包所在的SYN位置
peer := q2p.NewPeer("127.0.0.1", 10001, seedAddrs, []byte{0x0, 0x0}, callback, callbackFailed)
err := peer.Run()
if err != nil {
log.Fatal(err)
}
}通过运行q2p.NewPeer(ip, port, seedAddrs, networkID, timeSendLost, timeout, callback, callbackFunc)函数来运行一个节点）
参数 ip、port 是本节点要启动q2p网络主机所在的IP和端口组成的UDP地址 参数 seedAddrs 是一个map,其中每一个key都是一个种子节点的UDP地址 参数 networkID 是一个网络ID号，2个字节，这里使用0 参数 timeSendLost 是一个秒为单位的时间, 用来设置多久时间数据没收完，算丢包，可以根据此时间，通知发送节点重发丢失的数据包 参数 timeout 是一个秒为单位的时间，用来设置多久时间数据没有收完算超时，并通知发送节点本次传输超时结束 参数 callback 是用于收到TRANSPORT事件时的用户自定义函数，callback函数的参数data，是被TRANSPORT事件发来并处理的 参数 callbackFailed 接收到失败时的回调函数
数据传输通过 Transport 方法实现，该方法将数据分片并通过 UDP 进行发送，确保大数据量的可靠传输。如果数据传输失败，用户可以决定是否尝试重新传输。
在 transmission.go 中，transmissionSending 和 transmissionReceiving 函数处理了数据传输的发送和接收超时。如果在规定时间内没有收到完整的数据或发生错误，系统会记录传输失败，并触发相应的重试或失败处理机制。
以下是一个简单的使用示例：
package main
import (
"fmt"
"log"
"net"
"github.com/mosalut/q2p"
)
var transmissionCache = make(map[string][]byte)
func callback(peer *Peer_T, rAddr *net.UDPAddr, key string, data []byte) {
fmt.Println("Transmission hash:", key)
fmt.Println("Received data:", string(data))
}
func callbackFailed(peer *q2p.Peer_T, rAddr *net.UDPAddr, key string, syns []uint32) {
if len(syns) == 0 {
fmt.Println("transmission Failed, hash:", key)
return
}
data := transmissionCache[key]
var start int
var end int
for _, v := range syns {
start = v * q2p.PACKET_LEN
if start + q2p.PACKET_LEN > len(data) {
end = len(data)
} else {
end = start + q2p.PACKET_LEN
}
fmt.Println("lost SYN:", v, "data:", data[start:end])
err := peer.TransportAPacket(rAddr, key, syn, data[start:end])
if err != nil {
log.Println(err)
}
}
}
func main() {
peer := q2p.NewPeer("127.0.0.1", 10000, nil, 0, callback, callbackFailed)
err := peer.Run()
if err != nil {
log.Fatal(err)
}
// transport data
remoteAddr, _ := net.ResolveUDPAddr("udp", "127.0.0.1:10001")
data := []byte("Hello, P2P Network")
key, err := !peer.Transport(remoteAddr, data)
if err != nil {
log.Fatal(err)
}
transmissionCache[key] = data
}该项目提供了一些简单的单元测试，涵盖了 P2P 节点的基本运行和数据传输功能。你可以通过以下命令运行测试：
go test -v -count 1 test.run TestQ2p 或 go test -v -count 1 test.run TestTransport // 启动最初的种子节点 默认 host是127.0.0.1:10000
go test -v -count 1 test.run TestTransport -remote_host 127.0.0.1:10000 -port 10001
go test -v -count 1 test.run TestTransport -remote_host 127.0.0.1:10000 -port 10002q2p_test.go文件包含了用于测试节点连接、事件处理和数据传输的示例。
TestQ2p 测试函数主要体现了协议层的测试
TestTransport 测试函数模拟了数据传输的全过程，包括数据的发送和接收，验证了数据分片传输和超时控制机制。
欢迎提交 issues 和 pull requests，任何改进建议和功能需求都会被认真考虑。请确保代码符合 Go 语言的代码风格，并编写必要的单元测试。
此项目采用 GNU General Public License v3.0 许可证。
详细的许可证内容请参见 LICENSE 文件。