mirror of https://github.com/gorilla/websocket.git
ab5b3a61f5
Update the error messages for missing 'Connection: upgrade' and 'Upgrade: websocket' tokens to indicate that the header might not be present. The previous error message implied that the header is present, but has the wrong value. This leads to some confusion for those debugging connection problems. |
||
|---|---|---|
| examples | ||
| .gitignore | ||
| .travis.yml | ||
| AUTHORS | ||
| LICENSE | ||
| README.md | ||
| bench_test.go | ||
| client.go | ||
| client_server_test.go | ||
| client_test.go | ||
| conn.go | ||
| conn_test.go | ||
| doc.go | ||
| json.go | ||
| json_test.go | ||
| server.go | ||
| server_test.go | ||
| util.go | ||
| util_test.go | ||
README.md
Gorilla WebSocket
Gorilla WebSocket is a Go implementation of the WebSocket protocol.
Documentation
Status
The Gorilla WebSocket package provides a complete and tested implementation of the WebSocket protocol. The package API is stable.
Installation
go get github.com/gorilla/websocket
Protocol Compliance
The Gorilla WebSocket package passes the server tests in the Autobahn Test Suite using the application in the examples/autobahn subdirectory.
Gorilla WebSocket compared with other packages
| github.com/gorilla | golang.org/x/net | |
|---|---|---|
| RFC 6455 Features | ||
| Passes Autobahn Test Suite | Yes | No |
| Receive fragmented message | Yes | No, see note 1 |
| Send close message | Yes | No |
| Send pings and receive pongs | Yes | No |
| Get the type of a received data message | Yes | Yes, see note 2 |
| Other Features | ||
| Limit size of received message | Yes | No |
| Read message using io.Reader | Yes | No, see note 3 |
| Write message using io.WriteCloser | Yes | No, see note 3 |
Notes:
- Large messages are fragmented in Chrome's new WebSocket implementation.
- The application can get the type of a received data message by implementing a Codec marshal function.
- The go.net io.Reader and io.Writer operate across WebSocket frame boundaries. Read returns when the input buffer is full or a frame boundary is encountered. Each call to Write sends a single frame message. The Gorilla io.Reader and io.WriteCloser operate on a single WebSocket message.