History

George Tankersley 51614ecd2b module: run go mod tidy && go mod vendor		2019-02-14 18:56:16 +00:00
..
.gitignore	module: run go mod tidy && go mod vendor	2019-02-14 18:56:16 +00:00
.travis.yml	module: run go mod tidy && go mod vendor	2019-02-14 18:56:16 +00:00
AUTHORS	module: run go mod tidy && go mod vendor	2019-02-14 18:56:16 +00:00
LICENSE	module: run go mod tidy && go mod vendor	2019-02-14 18:56:16 +00:00
README.md	module: run go mod tidy && go mod vendor	2019-02-14 18:56:16 +00:00
client.go	module: run go mod tidy && go mod vendor	2019-02-14 18:56:16 +00:00
conn.go	module: run go mod tidy && go mod vendor	2019-02-14 18:56:16 +00:00
doc.go	module: run go mod tidy && go mod vendor	2019-02-14 18:56:16 +00:00
json.go	module: run go mod tidy && go mod vendor	2019-02-14 18:56:16 +00:00
server.go	module: run go mod tidy && go mod vendor	2019-02-14 18:56:16 +00:00
util.go	module: run go mod tidy && go mod vendor	2019-02-14 18:56:16 +00:00

README.md

Gorilla WebSocket

Gorilla WebSocket is a Go implementation of the WebSocket protocol.

NOTE: This is a fork/vendoring of http://github.com/gorilla/websocket The following documentation has been modified to point at this fork for convenience.

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/btcsuite/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

	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.