mirror of https://github.com/gorilla/websocket.git
292fd08b25
The documentation sometimes used the term "frame" when referring to single frame control messages. Use the term "message" for consistency in the documentation and to hide a detail that most application programmers do not need to know about. |
||
|---|---|---|
| examples | ||
| .gitignore | ||
| .travis.yml | ||
| AUTHORS | ||
| LICENSE | ||
| README.md | ||
| client.go | ||
| client_clone.go | ||
| client_clone_legacy.go | ||
| client_server_test.go | ||
| client_test.go | ||
| compression.go | ||
| compression_test.go | ||
| conn.go | ||
| conn_broadcast_test.go | ||
| conn_read.go | ||
| conn_read_legacy.go | ||
| conn_test.go | ||
| doc.go | ||
| example_test.go | ||
| json.go | ||
| json_test.go | ||
| mask.go | ||
| mask_safe.go | ||
| mask_test.go | ||
| prepared.go | ||
| prepared_test.go | ||
| proxy.go | ||
| server.go | ||
| server_test.go | ||
| util.go | ||
| util_test.go | ||
| x_net_proxy.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 | ||
| Compression Extensions | Experimental | 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.