Update README.md

This reverts commit 2f479b788c.

README.en.md

@@ -44,13 +44,13 @@ Help output under MacOS X:
 ```
 $ ./client_darwin_amd64 -h
 NAME:
-   kcptun - kcptun client
+   kcptun - client(with SMUX)
 
 USAGE:
    client_darwin_amd64 [global options] command [command options] [arguments...]
 
 VERSION:
-   20160820
+   20160922
 
 COMMANDS:
      help, h  Shows a list of commands or help for one command
@@ -58,30 +58,32 @@ COMMANDS:
 GLOBAL OPTIONS:
    --localaddr value, -l value   local listen address (default: ":12948")
    --remoteaddr value, -r value  kcp server address (default: "vps:29900")
-   --key value                   pre-shared secret for client and server (default: "it's a secrect") [$KCPTUN_KEY]
+   --key value                   pre-shared secret between client and server (default: "it's a secrect") [$KCPTUN_KEY]
    --crypt value                 aes, aes-128, aes-192, salsa20, blowfish, twofish, cast5, 3des, tea, xtea, xor, none (default: "aes")
    --mode value                  profiles: fast3, fast2, fast, normal (default: "fast")
    --conn value                  set num of UDP connections to server (default: 1)
-   --mtu value                   set maximum transmission unit of UDP packets (default: 1350)
+   --autoexpire value            set auto expiration time(in seconds) for a single UDP connection, 0 to disable (default: 0)
+   --mtu value                   set maximum transmission unit for UDP packets (default: 1350)
    --sndwnd value                set send window size(num of packets) (default: 128)
    --rcvwnd value                set receive window size(num of packets) (default: 1024)
    --datashard value             set reed-solomon erasure coding - datashard (default: 10)
    --parityshard value           set reed-solomon erasure coding - parityshard (default: 3)
    --dscp value                  set DSCP(6bit) (default: 0)
    --nocomp                      disable compression
+   --log value                   specify a log file to output, default goes to stderr
+   -c value                      config from json file, which will override the command from shell
    --help, -h                    show help
    --version, -v                 print the version
 
-
 $ ./server_darwin_amd64 -h
 NAME:
-   kcptun - kcptun server
+   kcptun - server(with SMUX)
 
 USAGE:
    server_darwin_amd64 [global options] command [command options] [arguments...]
 
 VERSION:
-   20160820
+   20160922
 
 COMMANDS:
      help, h  Shows a list of commands or help for one command
@@ -89,16 +91,18 @@ COMMANDS:
 GLOBAL OPTIONS:
    --listen value, -l value  kcp server listen address (default: ":29900")
    --target value, -t value  target server address (default: "127.0.0.1:12948")
-   --key value               pre-shared secret for client and server (default: "it's a secrect") [$KCPTUN_KEY]
+   --key value               pre-shared secret between client and server (default: "it's a secrect") [$KCPTUN_KEY]
    --crypt value             aes, aes-128, aes-192, salsa20, blowfish, twofish, cast5, 3des, tea, xtea, xor, none (default: "aes")
    --mode value              profiles: fast3, fast2, fast, normal (default: "fast")
-   --mtu value               set maximum transmission unit of UDP packets (default: 1350)
+   --mtu value               set maximum transmission unit for UDP packets (default: 1350)
    --sndwnd value            set send window size(num of packets) (default: 1024)
    --rcvwnd value            set receive window size(num of packets) (default: 1024)
    --datashard value         set reed-solomon erasure coding - datashard (default: 10)
    --parityshard value       set reed-solomon erasure coding - parityshard (default: 3)
    --dscp value              set DSCP(6bit) (default: 0)
    --nocomp                  disable compression
+   --log value               specify a log file to output, default goes to stderr
+   -c value                  config from json file, which will override the command from shell
    --help, -h                show help
    --version, -v             print the version
 ```
@@ -222,7 +226,7 @@ Of which ```RetransSegs,FastRetransSegs,LostSegs,OutSegs``` is the most useful.
 ### *Donations* :dollar:
 ![donate](donate.png)          
 
-All donations to this project will be used on the R&D of [gonet/2](http://gonet2.github.io/).
+Best wishes to you all.
 
 ### *References* :paperclip:
 1. https://github.com/skywind3000/kcp -- KCP - A Fast and Reliable ARQ Protocol.

README.md

@@ -41,13 +41,13 @@
 ```
 $ ./client_darwin_amd64 -h
 NAME:
-   kcptun - kcptun client
+   kcptun - client(with SMUX)
 
 USAGE:
    client_darwin_amd64 [global options] command [command options] [arguments...]
 
 VERSION:
-   20160820
+   20160922
 
 COMMANDS:
      help, h  Shows a list of commands or help for one command
@@ -55,30 +55,32 @@ COMMANDS:
 GLOBAL OPTIONS:
    --localaddr value, -l value   local listen address (default: ":12948")
    --remoteaddr value, -r value  kcp server address (default: "vps:29900")
-   --key value                   pre-shared secret for client and server (default: "it's a secrect") [$KCPTUN_KEY]
+   --key value                   pre-shared secret between client and server (default: "it's a secrect") [$KCPTUN_KEY]
    --crypt value                 aes, aes-128, aes-192, salsa20, blowfish, twofish, cast5, 3des, tea, xtea, xor, none (default: "aes")
    --mode value                  profiles: fast3, fast2, fast, normal (default: "fast")
    --conn value                  set num of UDP connections to server (default: 1)
-   --mtu value                   set maximum transmission unit of UDP packets (default: 1350)
+   --autoexpire value            set auto expiration time(in seconds) for a single UDP connection, 0 to disable (default: 0)
+   --mtu value                   set maximum transmission unit for UDP packets (default: 1350)
    --sndwnd value                set send window size(num of packets) (default: 128)
    --rcvwnd value                set receive window size(num of packets) (default: 1024)
    --datashard value             set reed-solomon erasure coding - datashard (default: 10)
    --parityshard value           set reed-solomon erasure coding - parityshard (default: 3)
    --dscp value                  set DSCP(6bit) (default: 0)
    --nocomp                      disable compression
+   --log value                   specify a log file to output, default goes to stderr
+   -c value                      config from json file, which will override the command from shell
    --help, -h                    show help
    --version, -v                 print the version
 
-
 $ ./server_darwin_amd64 -h
 NAME:
-   kcptun - kcptun server
+   kcptun - server(with SMUX)
 
 USAGE:
    server_darwin_amd64 [global options] command [command options] [arguments...]
 
 VERSION:
-   20160820
+   20160922
 
 COMMANDS:
      help, h  Shows a list of commands or help for one command
@@ -86,16 +88,18 @@ COMMANDS:
 GLOBAL OPTIONS:
    --listen value, -l value  kcp server listen address (default: ":29900")
    --target value, -t value  target server address (default: "127.0.0.1:12948")
-   --key value               pre-shared secret for client and server (default: "it's a secrect") [$KCPTUN_KEY]
+   --key value               pre-shared secret between client and server (default: "it's a secrect") [$KCPTUN_KEY]
    --crypt value             aes, aes-128, aes-192, salsa20, blowfish, twofish, cast5, 3des, tea, xtea, xor, none (default: "aes")
    --mode value              profiles: fast3, fast2, fast, normal (default: "fast")
-   --mtu value               set maximum transmission unit of UDP packets (default: 1350)
+   --mtu value               set maximum transmission unit for UDP packets (default: 1350)
    --sndwnd value            set send window size(num of packets) (default: 1024)
    --rcvwnd value            set receive window size(num of packets) (default: 1024)
    --datashard value         set reed-solomon erasure coding - datashard (default: 10)
    --parityshard value       set reed-solomon erasure coding - parityshard (default: 3)
    --dscp value              set DSCP(6bit) (default: 0)
    --nocomp                  disable compression
+   --log value               specify a log file to output, default goes to stderr
+   -c value                  config from json file, which will override the command from shell
    --help, -h                show help
    --version, -v             print the version
 ```
@@ -175,6 +179,8 @@ DSCP差分服务代码点（Differentiated Services Code Point），IETF于1998
 
 通过 ```-dscp ``` 参数指定dscp值，两端可分别设定。
 
+注意：设置dscp不一定会更好，需要尝试。
+
 ### *前向纠错* :lollipop: 
 前向纠错采用Reed Solomon纠删码, 它的基本原理如下： 给定n个数据块d1, d2,…, dn，n和一个正整数m， RS根据n个数据块生成m个校验块， c1, c2,…, cm。 对于任意的n和m， 从n个原始数据块和m 个校验块中任取n块就能解码出原始数据， 即RS最多容忍m个数据块或者校验块同时丢失。
 
@@ -254,9 +260,9 @@ type Snmp struct {
 ### *捐赠* :dollar:
 ![donate](donate.png)          
 
-对该项目的捐款将用于[gonet/2](http://gonet2.github.io/)游戏服务器框架的研发。     
+好人一生平安
 
-```特别感谢: 郑H立, 南D风, Li, 七q, 凌J，昶，Les*ables, Ky*n, 噼**啦, *斌, 小苍** 等，名字已做特殊处理。```
+```特别感谢: 郑H立, 南D风, Li, 七q, 凌J，昶，Les*ables, Ky*n, 噼**啦, *斌, 小苍**, Ken 等，名字已做特殊处理。```
 
 ### *参考资料* :paperclip:
 1. https://github.com/skywind3000/kcp -- KCP - A Fast and Reliable ARQ Protocol.

client/config.go

@@ -28,6 +28,7 @@ type Config struct {
 	NoCongestion int    `json:"nc"`
 	SockBuf      int    `json:"sockbuf"`
 	KeepAlive    int    `json:"keepalive"`
+	Log          string `json:"log"`
 }
 
 func parseJSONConfig(config *Config, path string) error {

client/main.go

@@ -12,6 +12,7 @@ import (
 	"golang.org/x/crypto/pbkdf2"
 
 	"github.com/golang/snappy"
+	"github.com/pkg/errors"
 	"github.com/urfave/cli"
 	kcp "github.com/xtaci/kcp-go"
 	"github.com/xtaci/smux"
@@ -60,16 +61,10 @@ func handleClient(p1, p2 io.ReadWriteCloser) {
 
 	// start tunnel
 	p1die := make(chan struct{})
-	go func() {
-		io.Copy(p1, p2)
-		close(p1die)
-	}()
+	go func() { io.Copy(p1, p2); close(p1die) }()
 
 	p2die := make(chan struct{})
-	go func() {
-		io.Copy(p2, p1)
-		close(p2die)
-	}()
+	go func() { io.Copy(p2, p1); close(p2die) }()
 
 	// wait for tunnel termination
 	select {
@@ -201,6 +196,11 @@ func main() {
 			Value:  10, // nat keepalive interval in seconds
 			Hidden: true,
 		},
+		cli.StringFlag{
+			Name:  "log",
+			Value: "",
+			Usage: "specify a log file to output, default goes to stderr",
+		},
 		cli.StringFlag{
 			Name:  "c",
 			Value: "", // when the value is not empty, the config path must exists
@@ -230,12 +230,21 @@ func main() {
 		config.NoCongestion = c.Int("nc")
 		config.SockBuf = c.Int("sockbuf")
 		config.KeepAlive = c.Int("keepalive")
+		config.Log = c.String("log")
 
 		if c.String("c") != "" {
 			err := parseJSONConfig(&config, c.String("c"))
 			checkError(err)
 		}
 
+		// log redirect
+		if config.Log != "" {
+			f, err := os.OpenFile(config.Log, os.O_RDWR|os.O_CREATE|os.O_APPEND, 0666)
+			checkError(err)
+			defer f.Close()
+			log.SetOutput(f)
+		}
+
 		switch config.Mode {
 		case "normal":
 			config.NoDelay, config.Interval, config.Resend, config.NoCongestion = 0, 30, 2, 1
@@ -301,9 +310,11 @@ func main() {
 		smuxConfig := smux.DefaultConfig()
 		smuxConfig.MaxReceiveBuffer = config.SockBuf
 
-		createConn := func() *smux.Session {
+		createConn := func() (*smux.Session, error) {
 			kcpconn, err := kcp.DialWithOptions(config.RemoteAddr, block, config.DataShard, config.ParityShard)
-			checkError(err)
+			if err != nil {
+				return nil, errors.Wrap(err, "createConn()")
+			}
 			kcpconn.SetStreamMode(true)
 			kcpconn.SetNoDelay(config.NoDelay, config.Interval, config.Resend, config.NoCongestion)
 			kcpconn.SetWindowSize(config.SndWnd, config.RcvWnd)
@@ -328,8 +339,21 @@ func main() {
 			} else {
 				session, err = smux.Client(newCompStream(kcpconn), smuxConfig)
 			}
-			checkError(err)
-			return session
+			if err != nil {
+				return nil, errors.Wrap(err, "createConn()")
+			}
+			return session, nil
+		}
+
+		// wait until a connection is ready
+		waitConn := func() *smux.Session {
+			for {
+				if session, err := createConn(); err == nil {
+					return session
+				} else {
+					time.Sleep(time.Second)
+				}
+			}
 		}
 
 		numconn := uint16(config.Conn)
@@ -339,7 +363,9 @@ func main() {
 		}, numconn)
 
 		for k := range muxes {
-			muxes[k].session = createConn()
+			sess, err := createConn()
+			checkError(err)
+			muxes[k].session = sess
 			muxes[k].ttl = time.Now().Add(time.Duration(config.AutoExpire) * time.Second)
 		}
 
@@ -361,7 +387,7 @@ func main() {
 			// do auto expiration
 			if config.AutoExpire > 0 && time.Now().After(muxes[idx].ttl) {
 				chScavenger <- muxes[idx].session
-				muxes[idx].session = createConn()
+				muxes[idx].session = waitConn()
 				muxes[idx].ttl = time.Now().Add(time.Duration(config.AutoExpire) * time.Second)
 			}
 
@@ -369,7 +395,7 @@ func main() {
 			p2, err := muxes[idx].session.OpenStream()
 			if err != nil { // mux failure
 				chScavenger <- muxes[idx].session
-				muxes[idx].session = createConn()
+				muxes[idx].session = waitConn()
 				muxes[idx].ttl = time.Now().Add(time.Duration(config.AutoExpire) * time.Second)
 				goto OPEN_P2
 			}

server/config.go

@@ -26,6 +26,7 @@ type Config struct {
 	NoCongestion int    `json:"nc"`
 	SockBuf      int    `json:"sockbuf"`
 	KeepAlive    int    `json:"keepalive"`
+	Log          string `json:"log"`
 }
 
 func parseJSONConfig(config *Config, path string) error {

server/main.go

@@ -93,16 +93,10 @@ func handleClient(p1, p2 io.ReadWriteCloser) {
 
 	// start tunnel
 	p1die := make(chan struct{})
-	go func() {
-		io.Copy(p1, p2)
-		close(p1die)
-	}()
+	go func() { io.Copy(p1, p2); close(p1die) }()
 
 	p2die := make(chan struct{})
-	go func() {
-		io.Copy(p2, p1)
-		close(p2die)
-	}()
+	go func() { io.Copy(p2, p1); close(p2die) }()
 
 	// wait for tunnel termination
 	select {
@@ -224,6 +218,11 @@ func main() {
 			Value:  10, // nat keepalive interval in seconds
 			Hidden: true,
 		},
+		cli.StringFlag{
+			Name:  "log",
+			Value: "",
+			Usage: "specify a log file to output, default goes to stderr",
+		},
 		cli.StringFlag{
 			Name:  "c",
 			Value: "", // when the value is not empty, the config path must exists
@@ -251,6 +250,7 @@ func main() {
 		config.NoCongestion = c.Int("nc")
 		config.SockBuf = c.Int("sockbuf")
 		config.KeepAlive = c.Int("keepalive")
+		config.Log = c.String("log")
 
 		if c.String("c") != "" {
 			//Now only support json config file
@@ -258,6 +258,14 @@ func main() {
 			checkError(err)
 		}
 
+		// log redirect
+		if config.Log != "" {
+			f, err := os.OpenFile(config.Log, os.O_RDWR|os.O_CREATE|os.O_APPEND, 0666)
+			checkError(err)
+			defer f.Close()
+			log.SetOutput(f)
+		}
+
 		switch config.Mode {
 		case "normal":
 			config.NoDelay, config.Interval, config.Resend, config.NoCongestion = 0, 30, 2, 1