update document

lxzan · Jan 6, 2023 · 8c22307 · 8c22307
1 parent dce24f8
commit 8c22307
Show file tree

Hide file tree

Showing 8 changed files with 35 additions and 30 deletions.
diff --git a/Makefile b/Makefile
@@ -3,3 +3,6 @@ test:
 
 bench:
 	go test -benchmem  -bench ^Benchmark github.com/lxzan/gws
+
+build:
+	CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -o bin/gws-server-linux-amd64 github.com/lxzan/gws/examples/testsuite
diff --git a/README.md b/README.md
@@ -3,9 +3,9 @@
 
 #### Highlight
 - websocket event api
-- write in batch and flush 
-- no dependency
-- zero goroutine to control websocket
+- zero dependency
+- zero extra goroutine to control websocket
+- zero error to read/write message, errors have been handled appropriately
 - fully passes the WebSocket [autobahn-testsuite](https://github.com/crossbario/autobahn-testsuite)
 
 #### Attention
@@ -16,12 +16,12 @@
 #### Interface
 ```go
 type Event interface {
-	OnOpen(socket *Conn)
-	OnError(socket *Conn, err error)
-	OnClose(socket *Conn, message *Message)
-	OnMessage(socket *Conn, message *Message)
-	OnPing(socket *Conn, message *Message)
-	OnPong(socket *Conn, message *Message)
+    OnOpen(socket *Conn)
+    OnError(socket *Conn, err error)
+    OnClose(socket *Conn, code uint16, reason []byte)
+    OnPing(socket *Conn, payload []byte)
+    OnPong(socket *Conn, payload []byte)
+    OnMessage(socket *Conn, message *Message)
 }
 ```
 
@@ -37,16 +37,14 @@ import (
 )
 
 func main() {
-	var upgrader = gws.Upgrader{CompressEnabled: true, MaxContentLength: 32 * 1024 * 1024}
+	var config = gws.Config{CompressEnabled: true, CheckTextEncoding: true, MaxContentLength: 32 * 1024 * 1024}
 	var handler = new(WebSocket)
 
 	http.HandleFunc("/connect", func(writer http.ResponseWriter, request *http.Request) {
-		socket, err := upgrader.Upgrade(context.Background(), writer, request, handler)
+		socket, err := gws.Accept(context.Background(), writer, request, handler, config)
 		if err != nil {
 			return
 		}
-
-		defer socket.Close()
 		socket.Listen()
 	})
 
@@ -55,9 +53,8 @@ func main() {
 
 type WebSocket struct{}
 
-func (c *WebSocket) OnClose(socket *gws.Conn, message *gws.Message) {
-	fmt.Printf("onclose: code=%d, payload=%s\n", message.Code(), string(message.Bytes()))
-	message.Close()
+func (c *WebSocket) OnClose(socket *gws.Conn, code uint16, reason []byte) {
+	fmt.Printf("onclose: code=%d, payload=%s\n", code, string(reason))
 }
 
 func (c *WebSocket) OnError(socket *gws.Conn, err error) {
@@ -68,16 +65,15 @@ func (c *WebSocket) OnOpen(socket *gws.Conn) {
 	println("connected")
 }
 
-func (c *WebSocket) OnMessage(socket *gws.Conn, message *gws.Message) {
-	socket.WriteMessage(message.Typ(), message.Bytes())
-	message.Close()
+func (c *WebSocket) OnPing(socket *gws.Conn, payload []byte) {
+	fmt.Printf("onping: payload=%s\n", string(payload))
+	socket.WritePong(payload)
 }
 
-func (c *WebSocket) OnPing(socket *gws.Conn, message *gws.Message) {
-	fmt.Printf("onping: payload=%s\n", string(message.Bytes()))
-	socket.WritePong(message.Bytes())
+func (c *WebSocket) OnPong(socket *gws.Conn, payload []byte) {}
+
+func (c *WebSocket) OnMessage(socket *gws.Conn, message *gws.Message) {
+	socket.WriteMessage(message.Typ(), message.Bytes())
 	message.Close()
 }
-
-func (c *WebSocket) OnPong(socket *gws.Conn, message *gws.Message) {}
 ```
diff --git a/compress.go b/compress.go
@@ -65,7 +65,7 @@ func (c *decompressor) Decompress(payload *internal.Buffer) (*internal.Buffer, e
 		return nil, err
 	}
 
-	var buf = _pool.Get(payload.Len())
+	var buf = _pool.Get(3 * payload.Len())
 	_, err := io.Copy(buf, c.fr)
 	_pool.Put(payload)
 	return buf, err

diff --git a/conn.go b/conn.go
@@ -75,9 +75,6 @@ func serveWebSocket(ctx context.Context, config Config, r *internal.Request, net
 func (c *Conn) Listen() {
 	defer c.conn.Close()
 	for {
-		if atomic.LoadUint32(&c.closed) == 1 {
-			return
-		}
 		if err := c.readMessage(); err != nil {
 			c.emitError(err)
 			return

diff --git a/examples/bench/index.html b/examples/bench/index.html
@@ -70,7 +70,7 @@
 
     ws.onmessage = function (msg) {
         if (msg.data != "ok") {
-            // ws.send(msg.data);
+            ws.send(msg.data);
             count++;
         }
         if (count == 1000000) {

diff --git a/examples/bench/main.go b/examples/bench/main.go
@@ -24,7 +24,7 @@ func main() {
 	var ctx = context.Background()
 
 	http.HandleFunc("/connect", func(writer http.ResponseWriter, request *http.Request) {
-		socket, err := gws.Accept(ctx, writer, request, handler, gws.Config{CheckTextEncoding: true})
+		socket, err := gws.Accept(ctx, writer, request, handler, gws.Config{})
 		if err != nil {
 			return
 		}
@@ -104,6 +104,7 @@ func (c *WebSocket) OnTest(socket *gws.Conn) {
 func (c *WebSocket) OnVerify(socket *gws.Conn) {
 	if socket.Len() != 0 {
 		socket.WriteMessage(gws.OpcodeText, []byte("failed"))
+		return
 	}
 	socket.WriteMessage(gws.OpcodeText, []byte("ok"))
 }

diff --git a/reader.go b/reader.go
@@ -6,6 +6,7 @@ import (
 	"github.com/lxzan/gws/internal"
 	"io"
 	"strconv"
+	"sync/atomic"
 )
 
 var _pool *internal.BufferPool
@@ -74,6 +75,9 @@ func (c *Conn) readControl() error {
 }
 
 func (c *Conn) readMessage() error {
+	if atomic.LoadUint32(&c.closed) == 1 {
+		return internal.CloseNormalClosure
+	}
 	if err := c.readN(c.fh[:2], 2); err != nil {
 		return err
 	}

diff --git a/writer.go b/writer.go
@@ -3,6 +3,7 @@ package gws
 import (
 	"github.com/lxzan/gws/internal"
 	"io"
+	"sync/atomic"
 )
 
 func writeN(writer io.Writer, content []byte, n int) error {
@@ -47,6 +48,9 @@ func (c *Conn) WritePong(payload []byte) {
 // text message must be utf8 encoding
 // 发送文本/二进制消息, 文本消息必须是utf8编码
 func (c *Conn) WriteMessage(opcode Opcode, payload []byte) {
+	if atomic.LoadUint32(&c.closed) == 1 {
+		return
+	}
 	c.emitError(c.writeMessage(opcode, payload))
 }
-Original file line number
+Diff line change
@@ Expand Up / @@ -3,3 +3,6 @@ test: @@
     bench:
     	go test -benchmem  -bench ^Benchmark github.com/lxzan/gws
+    build:
+    	CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -o bin/gws-server-linux-amd64 github.com/lxzan/gws/examples/testsuite