mirror of https://github.com/gorilla/websocket.git
1.9 KiB
1.9 KiB
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 WebSockets Test Suite using the application in the examples/autobahn subdirectory.
Gorilla WebSocket compared with other packages
| gorilla | go.net | |
|---|---|---|
| Protocol support | RFC 6455 | RFC 6455 |
| Limit size of received message | Yes | No |
| Send pings and receive pongs | Yes | No |
| Send close message | Yes | No |
| Read message using io.Reader | Yes | No, see note |
| Write message using io.WriteCloser | Yes | No, see note |
| Encode, decode JSON message | Yes | Yes |
Note: The go.net io.Reader and io.Writer operate across WebSocket message boundaries. Read returns when the input buffer is full or a message boundary is encountered, Each call to Write sends a message. The Gorilla io.Reader and io.WriteCloser operate on a single WebSocket message.