upd

optmize cli flags for accept callback

README.en.md

@@ -1,5 +1,5 @@
 # <img src="logo.png" alt="kcptun" height="60px" /> 
-[![GoDoc][1]][2] [![Release][13]][14] [![Powered][17]][18] [![Build Status][3]][4] [![Go Report Card][5]][6] [![Downloads][15]][16] 
+[![GoDoc][1]][2] [![Release][13]][14] [![Powered][17]][18] [![MIT licensed][11]][12] [![Build Status][3]][4] [![Go Report Card][5]][6] [![Downloads][15]][16] [![Gitter][19]][20]
 [1]: https://godoc.org/github.com/xtaci/kcptun?status.svg
 [2]: https://godoc.org/github.com/xtaci/kcptun
 [3]: https://travis-ci.org/xtaci/kcptun.svg?branch=master
@@ -10,16 +10,16 @@
 [8]: https://raw.githubusercontent.com/xtaci/kcptun/master/LICENSE.md
 [9]: https://img.shields.io/github/stars/xtaci/kcptun.svg
 [10]: https://github.com/xtaci/kcptun/stargazers
-[11]: https://img.shields.io/github/forks/xtaci/kcptun.svg
-[12]: https://github.com/xtaci/kcptun/network
+[11]: https://img.shields.io/badge/license-MIT-blue.svg
+[12]: LICENSE.md
 [13]: https://img.shields.io/github/release/xtaci/kcptun.svg
 [14]: https://github.com/xtaci/kcptun/releases/latest
 [15]: https://img.shields.io/github/downloads/xtaci/kcptun/total.svg?maxAge=1800
 [16]: https://github.com/xtaci/kcptun/releases
 [17]: https://img.shields.io/badge/KCP-Powered-blue.svg
 [18]: https://github.com/skywind3000/kcp
-[19]: https://img.shields.io/docker/pulls/xtaci/kcptun.svg?maxAge=1800
-[20]: https://hub.docker.com/r/xtaci/kcptun/
+[19]: https://badges.gitter.im/xtaci/kcptun.svg
+[20]: https://gitter.im/xtaci/kcptun?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge
 
 A tool for converting tcp stream into kcp+udp stream, :zap: ***[download address](https://github.com/xtaci/kcptun/releases/latest)***:zap:
 
@@ -35,7 +35,9 @@ Client Side: ./client_darwin_amd64 -r "SERVERIP:554" -l ":1080" -mode fast2  //
 
 ### *Performance* :lollipop:
 <img src="fast.png" alt="fast.com" height="256px" />       
-Speed tested with: https://fast.com
+* Speed tested with: https://fast.com
+* WAN Link Speed: 100M ADSL
+* WIFI: 5GHz TL-WDR3320
 
 ### *Usage* :lollipop:
 ![client](client.png)
@@ -57,6 +59,8 @@ CLIENT:   -mtu 1400 -sndwnd 256 -rcvwnd 2048 -mode fast2 -dscp 46
 > Step 1：Increase client rcvwnd & server sndwnd simultaneously & gradually。       
 > Step 2：Try download something and observer, if the bandwidth usage is close the limit then stop, otherwise goto step 1.     
 
+***NOTICE: if too much retranmission happens, it's quite possible the windows are too large***
+
 ### *Traffic Control* :lollipop: 
 ***Intended audience : for those server's bandwidth is quite limited.***      
 
@@ -110,6 +114,8 @@ Setting parameters of RS-Code with ```-datashard 10 -parityshard 3```
 
 disable compression by setting ```-nocomp``` on both side.
 
+> Tips: Turning off compression may reduce latency.
+
 ### *SNMP* :lollipop:
 ```go
 // Snmp defines network statistics indicator

README.md

@@ -1,5 +1,5 @@
 # <img src="logo.png" alt="kcptun" height="60px" /> 
-[![GoDoc][1]][2] [![Release][13]][14] [![Powered][17]][18] [![Build Status][3]][4] [![Go Report Card][5]][6] [![Downloads][15]][16] 
+[![GoDoc][1]][2] [![Release][13]][14] [![Powered][17]][18] [![MIT licensed][11]][12] [![Build Status][3]][4] [![Go Report Card][5]][6] [![Downloads][15]][16] [![Gitter][19]][20]
 [1]: https://godoc.org/github.com/xtaci/kcptun?status.svg
 [2]: https://godoc.org/github.com/xtaci/kcptun
 [3]: https://travis-ci.org/xtaci/kcptun.svg?branch=master
@@ -8,19 +8,18 @@
 [6]: https://goreportcard.com/report/github.com/xtaci/kcptun
 [7]: https://img.shields.io/badge/license-MIT-blue.svg
 [8]: https://raw.githubusercontent.com/xtaci/kcptun/master/LICENSE.md
-[9]: https://img.shields.io/github/stars/xtaci/kcptun.svg
-[10]: https://github.com/xtaci/kcptun/stargazers
-[11]: https://img.shields.io/github/forks/xtaci/kcptun.svg
-[12]: https://github.com/xtaci/kcptun/network
+[11]: https://img.shields.io/badge/license-MIT-blue.svg
+[12]: LICENSE.md
 [13]: https://img.shields.io/github/release/xtaci/kcptun.svg
 [14]: https://github.com/xtaci/kcptun/releases/latest
 [15]: https://img.shields.io/github/downloads/xtaci/kcptun/total.svg?maxAge=1800
 [16]: https://github.com/xtaci/kcptun/releases
 [17]: https://img.shields.io/badge/KCP-Powered-blue.svg
 [18]: https://github.com/skywind3000/kcp
-[19]: https://img.shields.io/docker/pulls/xtaci/kcptun.svg?maxAge=2592000
-[20]: https://hub.docker.com/r/xtaci/kcptun/
-***TCP端口加速器，用于[kcp-go](https://github.com/xtaci/kcp-go)协议测试 :zap: [官方下载地址](https://github.com/xtaci/kcptun/releases/latest):zap:***
+[19]: https://badges.gitter.im/xtaci/kcptun.svg
+[20]: https://gitter.im/xtaci/kcptun?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge
+
+***[kcp-go](https://github.com/xtaci/kcp-go)协议测试小工具 :zap: [官方下载地址](https://github.com/xtaci/kcptun/releases/latest):zap:***
 
 ![kcptun](kcptun.png)
 [English Readme](README.en.md)
@@ -33,7 +32,9 @@
 
 ### *速度对比* :lollipop:
 <img src="fast.png" alt="fast.com" height="256px" />       
-测速网站: https://fast.com
+* 测速网站: https://fast.com
+* 接入: 100M ADSL
+* WIFI: 5GHz TL-WDR3320
 
 ### *使用方法* :lollipop:
 在Mac OS X El Capitan下的帮助输出: 
@@ -51,10 +52,21 @@ CLIENT:   -mtu 1400 -sndwnd 256 -rcvwnd 2048 -mode fast2 -dscp 46
 *巭孬嫑乱动* 
 ```
 
+两端参数必须一致的有:
+* datashard
+* parityshard
+* nocomp
+* key
+* crypt
+
+其余为两边可独立设定的参数
+
 *简易自我调优方法*：
 > 第一步：同时在两端逐步增大client rcvwnd和server sndwnd;        
 > 第二步：尝试下载，观察如果带宽利用率（服务器＋客户端两端都要观察）接近物理带宽则停止，否则跳转到第一步。
 
+***注意：产生大量重传时，一定是窗口偏大了***
+
 *带宽计算公式*：
 ```
 在不丢包的情况下，有最大-rcvwnd 个数据包在网络上正在向你传输，以平均数据包大小avgsize计算，在任意时刻，有：     
@@ -123,6 +135,7 @@ DSCP差分服务代码点（Differentiated Services Code Point），IETF于1998
 > Reference: http://google.github.io/snappy/
 
 通过参数 ```-nocomp``` 在两端同时设定以关闭压缩。
+> 提示: 关闭压缩可能会降低延迟。
 
 ### *内置模式* :lollipop: 
 响应速度:     
@@ -182,7 +195,9 @@ type Snmp struct {
 ### *捐赠* :dollar:
 ![donate](donate.png)          
 
-对该项目的捐款将用于[gonet/2](http://gonet2.github.io/)游戏服务器框架的研发。
+对该项目的捐款将用于[gonet/2](http://gonet2.github.io/)游戏服务器框架的研发。     
+
+> 特别感谢: 郑H立, 南D风, Li, 七q, 凌J，昶，Les*ables, Ky*n等，名字已做特殊处理。
 
 ### *参考资料* :paperclip:
 1. https://github.com/skywind3000/kcp -- KCP - A Fast and Reliable ARQ Protocol.

client/main.go

@@ -14,7 +14,7 @@ import (
 	"github.com/golang/snappy"
 	"github.com/hashicorp/yamux"
 	"github.com/urfave/cli"
-	"github.com/xtaci/kcp-go"
+	kcp "github.com/xtaci/kcp-go"
 )
 
 var (
@@ -182,6 +182,16 @@ func main() {
 			Value:  0,
 			Hidden: true,
 		},
+		cli.IntFlag{
+			Name:   "sockbuf",
+			Value:  4194304, // socket buffer size in bytes
+			Hidden: true,
+		},
+		cli.IntFlag{
+			Name:   "keepalive",
+			Value:  10, // nat keepalive interval in seconds
+			Hidden: true,
+		},
 	}
 	myApp.Action = func(c *cli.Context) error {
 		log.Println("version:", VERSION)
@@ -189,7 +199,6 @@ func main() {
 		checkError(err)
 		listener, err := net.ListenTCP("tcp", addr)
 		checkError(err)
-		pass := pbkdf2.Key([]byte(c.String("key")), []byte(SALT), 4096, 32, sha1.New)
 
 		// kcp server
 		nodelay, interval, resend, nc := c.Int("nodelay"), c.Int("interval"), c.Int("resend"), c.Int("nc")
@@ -205,38 +214,59 @@ func main() {
 			nodelay, interval, resend, nc = 1, 10, 2, 1
 		}
 
+		crypt := c.String("crypt")
+		pass := pbkdf2.Key([]byte(c.String("key")), []byte(SALT), 4096, 32, sha1.New)
+		var block kcp.BlockCrypt
+		switch c.String("crypt") {
+		case "tea":
+			block, _ = kcp.NewTEABlockCrypt(pass[:16])
+		case "xor":
+			block, _ = kcp.NewSimpleXORBlockCrypt(pass)
+		case "none":
+			block, _ = kcp.NewNoneBlockCrypt(pass)
+		default:
+			block, _ = kcp.NewAESBlockCrypt(pass)
+		}
+
+		remoteaddr := c.String("remoteaddr")
+		datashard, parityshard := c.Int("datashard"), c.Int("parityshard")
+		mtu, sndwnd, rcvwnd := c.Int("mtu"), c.Int("sndwnd"), c.Int("rcvwnd")
+		nocomp, acknodelay := c.Bool("nocomp"), c.Bool("acknodelay")
+		dscp, sockbuf, keepalive, conn := c.Int("dscp"), c.Int("sockbuf"), c.Int("keepalive"), c.Int("conn")
+
 		log.Println("listening on:", listener.Addr())
-		log.Println("encryption:", c.String("crypt"))
+		log.Println("encryption:", crypt)
 		log.Println("nodelay parameters:", nodelay, interval, resend, nc)
-		log.Println("remote address:", c.String("remoteaddr"))
-		log.Println("sndwnd:", c.Int("sndwnd"), "rcvwnd:", c.Int("rcvwnd"))
-		log.Println("compression:", !c.Bool("nocomp"))
-		log.Println("mtu:", c.Int("mtu"))
-		log.Println("datashard:", c.Int("datashard"), "parityshard:", c.Int("parityshard"))
-		log.Println("acknodelay:", c.Bool("acknodelay"))
-		log.Println("dscp:", c.Int("dscp"))
-		log.Println("conn:", c.Int("conn"))
+		log.Println("remote address:", remoteaddr)
+		log.Println("sndwnd:", sndwnd, "rcvwnd:", rcvwnd)
+		log.Println("compression:", !nocomp)
+		log.Println("mtu:", mtu)
+		log.Println("datashard:", datashard, "parityshard:", parityshard)
+		log.Println("acknodelay:", acknodelay)
+		log.Println("dscp:", dscp)
+		log.Println("sockbuf:", sockbuf)
+		log.Println("keepalive:", keepalive)
+		log.Println("conn:", conn)
 
 		createConn := func() *yamux.Session {
-			var block kcp.BlockCrypt
-			switch c.String("crypt") {
-			case "tea":
-				block, _ = kcp.NewTEABlockCrypt(pass[:16])
-			case "xor":
-				block, _ = kcp.NewSimpleXORBlockCrypt(pass)
-			case "none":
-				block, _ = kcp.NewNoneBlockCrypt(pass)
-			default:
-				block, _ = kcp.NewAESBlockCrypt(pass)
-			}
-			kcpconn, err := kcp.DialWithOptions(c.String("remoteaddr"), block, c.Int("datashard"), c.Int("parityshard"))
+			kcpconn, err := kcp.DialWithOptions(remoteaddr, block, datashard, parityshard)
 			checkError(err)
 			kcpconn.SetStreamMode(true)
 			kcpconn.SetNoDelay(nodelay, interval, resend, nc)
-			kcpconn.SetWindowSize(c.Int("sndwnd"), c.Int("rcvwnd"))
-			kcpconn.SetMtu(c.Int("mtu"))
-			kcpconn.SetACKNoDelay(c.Bool("acknodelay"))
-			kcpconn.SetDSCP(c.Int("dscp"))
+			kcpconn.SetWindowSize(sndwnd, rcvwnd)
+			kcpconn.SetMtu(mtu)
+			kcpconn.SetACKNoDelay(acknodelay)
+			kcpconn.SetKeepAlive(keepalive)
+
+			if err := kcpconn.SetDSCP(dscp); err != nil {
+				log.Println("SetDSCP:", err)
+			}
+			if err := kcpconn.SetReadBuffer(sockbuf); err != nil {
+				log.Println("SetReadBuffer:", err)
+			}
+			if err := kcpconn.SetWriteBuffer(sockbuf); err != nil {
+				log.Println("SetWriteBuffer:", err)
+			}
 
 			// stream multiplex
 			config := &yamux.Config{
@@ -244,11 +274,11 @@ func main() {
 				EnableKeepAlive:        true,
 				KeepAliveInterval:      30 * time.Second,
 				ConnectionWriteTimeout: 30 * time.Second,
-				MaxStreamWindowSize:    16777216,
+				MaxStreamWindowSize:    uint32(sockbuf),
 				LogOutput:              os.Stderr,
 			}
 			var session *yamux.Session
-			if c.Bool("nocomp") {
+			if nocomp {
 				session, err = yamux.Client(kcpconn, config)
 			} else {
 				session, err = yamux.Client(newCompStream(kcpconn), config)
@@ -257,7 +287,7 @@ func main() {
 			return session
 		}
 
-		numconn := uint16(c.Int("conn"))
+		numconn := uint16(conn)
 		var muxes []*yamux.Session
 		for i := uint16(0); i < numconn; i++ {
 			muxes = append(muxes, createConn())
@@ -279,7 +309,6 @@ func main() {
 			go handleClient(p1, p2)
 			rr++
 		}
-		return nil
 	}
 	myApp.Run(os.Args)
 }

client/signal.go

@@ -8,7 +8,7 @@ import (
 	"os/signal"
 	"syscall"
 
-	"github.com/xtaci/kcp-go"
+	kcp "github.com/xtaci/kcp-go"
 )
 
 func init() {

server/main.go

@@ -14,7 +14,7 @@ import (
 	"github.com/golang/snappy"
 	"github.com/hashicorp/yamux"
 	"github.com/urfave/cli"
-	"github.com/xtaci/kcp-go"
+	kcp "github.com/xtaci/kcp-go"
 )
 
 var (
@@ -53,17 +53,9 @@ func newCompStream(conn net.Conn) *compStream {
 }
 
 // handle multiplex-ed connection
-func handleMux(conn io.ReadWriteCloser, target string) {
+func handleMux(conn io.ReadWriteCloser, target string, config *yamux.Config) {
 	// stream multiplex
 	var mux *yamux.Session
-	config := &yamux.Config{
-		AcceptBacklog:          256,
-		EnableKeepAlive:        true,
-		KeepAliveInterval:      30 * time.Second,
-		ConnectionWriteTimeout: 30 * time.Second,
-		MaxStreamWindowSize:    16777216,
-		LogOutput:              os.Stderr,
-	}
 	m, err := yamux.Server(conn, config)
 	if err != nil {
 		log.Println(err)
@@ -205,6 +197,16 @@ func main() {
 			Value:  0,
 			Hidden: true,
 		},
+		cli.IntFlag{
+			Name:   "sockbuf",
+			Value:  4194304, // socket buffer size in bytes
+			Hidden: true,
+		},
+		cli.IntFlag{
+			Name:   "keepalive",
+			Value:  10, // nat keepalive interval in seconds
+			Hidden: true,
+		},
 	}
 	myApp.Action = func(c *cli.Context) error {
 		log.Println("version:", VERSION)
@@ -220,9 +222,10 @@ func main() {
 			nodelay, interval, resend, nc = 1, 10, 2, 1
 		}
 
+		crypt := c.String("crypt")
 		pass := pbkdf2.Key([]byte(c.String("key")), []byte(SALT), 4096, 32, sha1.New)
 		var block kcp.BlockCrypt
-		switch c.String("crypt") {
+		switch crypt {
 		case "tea":
 			block, _ = kcp.NewTEABlockCrypt(pass[:16])
 		case "xor":
@@ -233,39 +236,65 @@ func main() {
 			block, _ = kcp.NewAESBlockCrypt(pass)
 		}
 
-		lis, err := kcp.ListenWithOptions(c.String("listen"), block, c.Int("datashard"), c.Int("parityshard"))
+		datashard, parityshard := c.Int("datashard"), c.Int("parityshard")
+		lis, err := kcp.ListenWithOptions(c.String("listen"), block, datashard, parityshard)
 		if err != nil {
 			log.Fatal(err)
 		}
+
+		mtu, sndwnd, rcvwnd := c.Int("mtu"), c.Int("sndwnd"), c.Int("rcvwnd")
+		nocomp, acknodelay := c.Bool("nocomp"), c.Bool("acknodelay")
+		dscp, sockbuf, keepalive := c.Int("dscp"), c.Int("sockbuf"), c.Int("keepalive")
+		target := c.String("target")
+
 		log.Println("listening on ", lis.Addr())
-		log.Println("encryption:", c.String("crypt"))
+		log.Println("encryption:", crypt)
 		log.Println("nodelay parameters:", nodelay, interval, resend, nc)
-		log.Println("sndwnd:", c.Int("sndwnd"), "rcvwnd:", c.Int("rcvwnd"))
-		log.Println("compression:", !c.Bool("nocomp"))
-		log.Println("mtu:", c.Int("mtu"))
-		log.Println("datashard:", c.Int("datashard"), "parityshard:", c.Int("parityshard"))
-		log.Println("acknodelay:", c.Bool("acknodelay"))
-		log.Println("dscp:", c.Int("dscp"))
+		log.Println("sndwnd:", sndwnd, "rcvwnd:", rcvwnd)
+		log.Println("compression:", !nocomp)
+		log.Println("mtu:", mtu)
+		log.Println("datashard:", datashard, "parityshard:", parityshard)
+		log.Println("acknodelay:", acknodelay)
+		log.Println("dscp:", dscp)
+		log.Println("sockbuf:", sockbuf)
+		log.Println("keepalive:", keepalive)
+
+		if err := lis.SetDSCP(dscp); err != nil {
+			log.Println("SetDSCP:", err)
+		}
+		if err := lis.SetReadBuffer(sockbuf); err != nil {
+			log.Println("SetReadBuffer:", err)
+		}
+		if err := lis.SetWriteBuffer(sockbuf); err != nil {
+			log.Println("SetWriteBuffer:", err)
+		}
+		config := &yamux.Config{
+			AcceptBacklog:          256,
+			EnableKeepAlive:        true,
+			KeepAliveInterval:      30 * time.Second,
+			ConnectionWriteTimeout: 30 * time.Second,
+			MaxStreamWindowSize:    uint32(sockbuf),
+			LogOutput:              os.Stderr,
+		}
 		for {
 			if conn, err := lis.Accept(); err == nil {
 				log.Println("remote address:", conn.RemoteAddr())
 				conn.SetStreamMode(true)
 				conn.SetNoDelay(nodelay, interval, resend, nc)
-				conn.SetMtu(c.Int("mtu"))
-				conn.SetWindowSize(c.Int("sndwnd"), c.Int("rcvwnd"))
-				conn.SetACKNoDelay(c.Bool("acknodelay"))
-				conn.SetDSCP(c.Int("dscp"))
+				conn.SetMtu(mtu)
+				conn.SetWindowSize(sndwnd, rcvwnd)
+				conn.SetACKNoDelay(acknodelay)
+				conn.SetKeepAlive(keepalive)
 
-				if c.Bool("nocomp") {
-					go handleMux(conn, c.String("target"))
+				if nocomp {
+					go handleMux(conn, target, config)
 				} else {
-					go handleMux(newCompStream(conn), c.String("target"))
+					go handleMux(newCompStream(conn), target, config)
 				}
 			} else {
 				log.Println(err)
 			}
 		}
-		return nil
 	}
 	myApp.Run(os.Args)
 }

server/signal.go

@@ -8,7 +8,7 @@ import (
 	"os/signal"
 	"syscall"
 
-	"github.com/xtaci/kcp-go"
+	kcp "github.com/xtaci/kcp-go"
 )
 
 func init() {