A fast, well-tested and widely used WebSocket implementation for Go.

go golang gorilla gorilla-websocket websocket

Go to file

Tarmigan Casebolt ae46df13e9 Fix Read() to return errUnexpectedEOF when EOF is received before all bytes in the frame have been read		2016-04-24 22:30:05 -07:00
examples	Fix filewatch example	2016-04-21 17:30:17 -07:00
.gitignore	Initial commit	2013-10-16 16:30:59 -07:00
.travis.yml	Drop Go 1.3 from supported configurations	2016-04-23 15:56:33 -07:00
AUTHORS	Relicense to the Gorilla WebSocket Authors.	2014-04-18 14:25:11 -07:00
LICENSE	Relicense to the Gorilla WebSocket Authors.	2014-04-18 14:25:11 -07:00
README.md	Add command example	2015-10-18 13:32:14 -07:00
bench_test.go	Add maskBytes benchmark.	2014-06-27 13:06:07 -07:00
client.go	Do not shallow copy crypto/tls.Config	2016-04-23 15:46:58 -07:00
client_server_test.go	Support proxy authorization for websocket client	2016-02-17 21:46:45 +09:00
client_test.go	Split raw query from opaque in URL parser	2015-12-15 21:10:58 -08:00
conn.go	Fix Read() to return errUnexpectedEOF when EOF is received before all bytes in the frame have been read	2016-04-24 22:30:05 -07:00
conn_test.go	Fix Read() to return errUnexpectedEOF when EOF is received before all bytes in the frame have been read	2016-04-24 22:30:05 -07:00
doc.go	Document that default ping handler can block	2016-03-13 12:14:46 -07:00
example_test.go	Fix go vet warning	2016-03-02 14:56:29 -08:00
json.go	Provide all close frame data to application	2015-08-11 10:14:32 -07:00
json_test.go	Provide all close frame data to application	2015-08-11 10:14:32 -07:00
server.go	Add IsWebSocketUpgrade	2016-03-09 10:36:44 -08:00
server_test.go	Add IsWebSocketUpgrade	2016-03-09 10:36:44 -08:00
util.go	Relicense to the Gorilla WebSocket Authors.	2014-04-18 14:25:11 -07:00
util_test.go	Add test for function tokenListContainsValue	2014-11-17 04:16:34 -08:00

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.