A WebSocket implementation for Go.
Switch branches/tags
Nothing to show
Clone or download
Latest commit 95ba29e Dec 5, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
examples Updated autobahn test suite URL Dec 6, 2018
.gitignore add newline and remove extra space Mar 4, 2018
.travis.yml miscellaneous cleanup Aug 24, 2018
AUTHORS Update LICENSE file to reflect Google employee contributions. Jun 5, 2018
LICENSE Relicense to the Gorilla WebSocket Authors. Apr 18, 2014
README.md Updated autobahn test suite URL Dec 6, 2018
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 18, 2017
client_clone_legacy.go Update cloneTLSConfig to use Go 1.8 Config.Clone method Feb 18, 2017
client_server_test.go Add comprehensive host test (#429) Sep 24, 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 24, 2017
compression_test.go Add write buffer pooling Aug 22, 2018
conn.go Add "in bytes" to sizes in documentation Oct 30, 2018
conn_broadcast_test.go miscellaneous cleanup Aug 24, 2018
conn_test.go Return write buffer to pool on write error (#427) Sep 24, 2018
conn_write.go Use net.Buffers to write multiple slices to connection Mar 6, 2018
conn_write_legacy.go Use net.Buffers to write multiple slices to connection Mar 6, 2018
doc.go Improve check origin documentation Jan 25, 2018
example_test.go Fix go vet warning Mar 2, 2016
json.go Misc cleanup Jul 18, 2017
json_test.go Add write buffer pooling Aug 22, 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 24, 2018
prepared.go miscellaneous cleanup Aug 24, 2018
prepared_test.go Add write buffer pooling Aug 22, 2018
proxy.go Minor fixes in comments Apr 16, 2018
server.go Add "in bytes" to sizes in documentation Oct 30, 2018
server_test.go miscellaneous cleanup Aug 24, 2018
trace.go Add context in the Dialer Aug 24, 2018
trace_17.go Add context in the Dialer Aug 24, 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

README.md

Gorilla WebSocket

Gorilla WebSocket is a Go implementation of the WebSocket protocol.

Build Status GoDoc

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 SuiteYesNo
Receive fragmented messageYesNo, see note 1
Send close messageYesNo
Send pings and receive pongsYesNo
Get the type of a received data messageYesYes, see note 2
Other Features
Compression ExtensionsExperimentalNo
Read message using io.ReaderYesNo, see note 3
Write message using io.WriteCloserYesNo, see note 3

Notes:

  1. Large messages are fragmented in Chrome's new WebSocket implementation.
  2. The application can get the type of a received data message by implementing a Codec marshal function.
  3. 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.