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

go golang gorilla gorilla-websocket websocket

Go to file

David Dollar b648f206c2 Use ASCII case folding in same origin test		2017-11-27 16:10:45 -08:00
examples	Add missing html tag in example/echo	2017-09-26 16:13:09 -07:00
.gitignore	Meaningful names for hub	2016-05-18 08:56:16 -06:00
.travis.yml	Add Go 1.9 to Travis config	2017-09-13 22:11:54 -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	Replace parseURL() with net/url.Parse() (#290 )	2017-10-12 19:08:58 -07:00
client_clone.go	Update cloneTLSConfig to use Go 1.8 Config.Clone method	2017-02-18 08:27:10 -08:00
client_clone_legacy.go	Update cloneTLSConfig to use Go 1.8 Config.Clone method	2017-02-18 08:27:10 -08:00
client_server_test.go	Simplify and fix spelling errors in test files	2017-11-02 08:08:30 -07:00
client_test.go	Replace parseURL() with net/url.Parse() (#290 )	2017-10-12 19:08:58 -07:00
compression.go	fix flate write pool size to work with best compression	2017-01-25 02:15:04 +03:00
compression_test.go	remove test as HuffmanOnly compression level not defined in Go < 1.7	2017-01-25 02:34:04 +03:00
conn.go	Update with gofmt on tip	2017-11-23 00:11:29 -08:00
conn_broadcast_test.go	Prepared Messages (#211 )	2017-02-14 09:41:18 -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	Update with gofmt on tip	2017-11-23 00:11:29 -08:00
doc.go	Improve control message handling documentation	2017-11-19 13:55:18 -08:00
example_test.go	Fix go vet warning	2016-03-02 14:56:29 -08:00
json.go	Misc cleanup	2017-07-18 13:21:30 -07:00
json_test.go	Provide all close frame data to application	2015-08-11 10:14:32 -07:00
mask.go	Update with gofmt on tip	2017-11-23 00:11:29 -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
prepared.go	Prepared Messages (#211 )	2017-02-14 09:41:18 -08:00
prepared_test.go	Prepared Messages (#211 )	2017-02-14 09:41:18 -08:00
server.go	Use ASCII case folding in same origin test	2017-11-27 16:10:45 -08:00
server_test.go	Use ASCII case folding in same origin test	2017-11-27 16:10:45 -08:00
util.go	Update with gofmt on tip	2017-11-23 00:11:29 -08:00
util_test.go	Compare request header tokens with ASCII case folding	2017-11-22 23:15:27 -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
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.