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

go golang gorilla gorilla-websocket websocket

Go to file

Gary Burd 17634340a8 Update compression documentation Add "EXPERIMENTAL" to the compress section header. This change is intended to draw more attention to the status of the feature as stated in the first sentence of the section. This is not a change in the status.		2017-01-11 11:29:28 -08:00
examples	Fix up README.md for command example.	2016-12-27 15:04:14 +02:00
.gitignore	Meaningful names for hub	2016-05-18 08:56:16 -06:00
.travis.yml	Test w/ Go 1.7 on Travis	2016-10-20 16:33:47 -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	Update README.md	2016-10-21 12:35:05 -07:00
client.go	add cookie jar to dialer	2016-10-18 09:56:48 -07:00
client_server_test.go	add cookie jar to dialer	2016-10-18 09:56:48 -07:00
client_test.go	Split raw query from opaque in URL parser	2015-12-15 21:10:58 -08:00
compression.go	Compression improvements	2016-12-27 17:05:16 -05:00
compression_test.go	Add hooks to support RFC 7692 (per-message compression extension)	2016-06-29 17:03:55 -07:00
conn.go	Add safe maskBytes	2016-12-31 20:13:41 -08:00
conn_read.go	Reduce memory allocations in NextReader, NextWriter	2016-05-31 05:44:45 -07:00
conn_read_legacy.go	Reduce memory allocations in NextReader, NextWriter	2016-05-31 05:44:45 -07:00
conn_test.go	Improve write error handling	2016-11-02 09:59:14 -07:00
doc.go	Update compression documentation	2017-01-11 11:29:28 -08: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
mask.go	Add safe maskBytes	2016-12-31 20:13:41 -08:00
mask_safe.go	Add safe maskBytes	2016-12-31 20:13:41 -08:00
mask_test.go	Add safe maskBytes	2016-12-31 20:13:41 -08:00
server.go	compression: add tests, rename option	2016-10-17 17:30:22 -07:00
server_test.go	Add IsWebSocketUpgrade	2016-03-09 10:36:44 -08:00
util.go	Add Sec-WebSocket-Extensions header parser	2016-05-31 09:32:45 -07:00
util_test.go	Add Sec-WebSocket-Extensions header parser	2016-05-31 09:32:45 -07: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
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.