gorilla/websocket: A fast, well-tested and widely used WebSocket implementation for Go.

Join GitHub today

GitHub is home to over 40 million developers working together to host and review code, manage projects, and build software together.

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

Go 100.0%

Permalink

Name	Latest commit message	Commit time
Failed to load latest commit information.
.circleci	Create CircleCI config.yml (#519 )	Jun 30, 2019
.github	Create release-drafter.yml (#538 )	Aug 25, 2019
examples	Updated autobahn test suite URL	Dec 6, 2018
.gitignore	add newline and remove extra space	Mar 5, 2018
AUTHORS	Update LICENSE file to reflect Google employee contributions.	Jun 6, 2018
LICENSE	Relicense to the Gorilla WebSocket Authors.	Apr 19, 2014
README.md	Create CircleCI config.yml (#519 )	Jun 30, 2019
client.go	Add "in bytes" to sizes in documentation	Oct 30, 2018
client_clone.go	Update cloneTLSConfig to use Go 1.8 Config.Clone method	Feb 19, 2017
client_clone_legacy.go	Update cloneTLSConfig to use Go 1.8 Config.Clone method	Feb 19, 2017
client_server_test.go	Add comprehensive host test (#429 )	Sep 25, 2018
client_test.go	Replace parseURL() with net/url.Parse() (#290 )	Oct 13, 2017
compression.go	fix flate write pool size to work with best compression	Jan 25, 2017
compression_test.go	Add write buffer pooling	Aug 23, 2018
conn.go	Read Limit Fix (#537 )	Aug 25, 2019
conn_broadcast_test.go	miscellaneous cleanup	Aug 25, 2018
conn_test.go	Read Limit Fix (#537 )	Aug 25, 2019
conn_write.go	Use net.Buffers to write multiple slices to connection	Mar 7, 2018
conn_write_legacy.go	Use net.Buffers to write multiple slices to connection	Mar 7, 2018
doc.go	Add buffer commentary	Mar 6, 2019
example_test.go	Fix go vet warning	Mar 3, 2016
go.mod	Read Limit Fix (#537 )	Aug 25, 2019
go.sum	Add support for go-module	Feb 5, 2019
join.go	Add JoinMessages	Feb 5, 2019
join_test.go	Add JoinMessages	Feb 5, 2019
json.go	Misc cleanup	Jul 19, 2017
json_test.go	Add write buffer pooling	Aug 23, 2018
mask.go	Update with gofmt on tip	Nov 23, 2017
mask_safe.go	Add safe maskBytes	Jan 1, 2017
mask_test.go	miscellaneous cleanup	Aug 25, 2018
prepared.go	miscellaneous cleanup	Aug 25, 2018
prepared_test.go	Add write buffer pooling	Aug 23, 2018
proxy.go	Fix typo	Mar 6, 2019
server.go	fix typos (#532 )	Aug 23, 2019
server_test.go	miscellaneous cleanup	Aug 25, 2018
trace.go	Add context in the Dialer	Aug 25, 2018
trace_17.go	Add context in the Dialer	Aug 25, 2018
util.go	Improve header parsing code	Oct 6, 2018
util_test.go	Improve header parsing code	Oct 6, 2018
x_net_proxy.go	Add SOCKS5 support	Dec 1, 2017

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.