完善注释

gold/link/link.go

@@ -9,16 +9,29 @@ import (
 	"github.com/sirupsen/logrus"
 )
 
+// Link 是本机到 peer 的连接抽象
 type Link struct {
-	PubicKey      [32]byte
-	EndPoint      string
-	KeepAlive     int64
-	pipe          chan *head.Packet
-	peerip        net.IP
-	endpoint      *net.UDPAddr
-	allowedips    []*net.IPNet
-	hasKeepRuning bool
-	status        int
+	// peer 的公钥
+	pubk [32]byte
+	// peer 的公网 ip:port
+	pep string
+	// 决定本机是否定时向 peer 发送 hello 保持 NAT。
+	// 以秒为单位，小于等于 0 不发送
+	keepalive int64
+	// 收到的包的队列
+	pipe chan *head.Packet
+	// peer 的虚拟 ip
+	peerip net.IP
+	// peer 的公网 endpoint
+	endpoint *net.UDPAddr
+	// 本机允许接收/发送的 ip 网段
+	allowedips []*net.IPNet
+	// 是否已经调用过 keepAlive
+	haskeepruning bool
+	// 是否允许转发
+	allowtrans bool
+	// 连接的状态，详见下方 const
+	status int
 }
 
 const (
@@ -28,11 +41,15 @@ const (
 )
 
 var (
+	// 本机活跃的所有连接
 	connections = make(map[string]*Link)
-	connmapmu   sync.RWMutex
-	myconn      *net.UDPConn
+	// 读写同步锁
+	connmapmu sync.RWMutex
+	// 本机监听的 endpoint
+	myconn *net.UDPConn
 )
 
+// Connect 初始化与 peer 的连接
 func Connect(peer string) (*Link, error) {
 	p, ok := IsInPeer(net.ParseIP(peer).String())
 	if ok {
@@ -42,6 +59,7 @@ func Connect(peer string) (*Link, error) {
 	return nil, errors.New("peer not exist")
 }
 
+// Close 关闭到 peer 的连接
 func (l *Link) Close() {
 	connmapmu.Lock()
 	delete(connections, l.peerip.String())
@@ -49,10 +67,12 @@ func (l *Link) Close() {
 	l.status = LINK_STATUS_DOWN
 }
 
+// Read 从 peer 收包
 func (l *Link) Read() *head.Packet {
 	return <-l.pipe
 }
 
+// Write 向 peer 发包
 func (l *Link) Write(p *head.Packet) (n int, err error) {
 	p.Data, err = l.Encode(p.Data)
 	if err == nil {
@@ -60,7 +80,7 @@ func (l *Link) Write(p *head.Packet) (n int, err error) {
 		d, err = p.Mashal(me.String(), l.peerip.String())
 		logrus.Debugln("[link] write data", string(d))
 		if err == nil {
-			n, err = myconn.WriteToUDP(d, l.endpoint)
+			n, err = myconn.WriteToUDP(d, l.NextHop(l.peerip).endpoint)
 		}
 	}
 	return