A fast, well-tested and widely used WebSocket implementation for Go.
Go to file
Gary Burd a91eba7f97 Merge pull request #230 from FZambia/fix_client_compression
Enable client compression based on response header
2017-03-19 13:27:27 -04:00
examples Improve examples 2017-02-15 17:01:07 -08:00
.gitignore Meaningful names for hub 2016-05-18 08:56:16 -06:00
.travis.yml Add Go 1.8 to Travis config 2017-02-16 13:52:12 -08: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 enable client compression based on response header 2017-03-19 11:36:38 +03: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 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 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 Use bufio.Writer returned from hijack in upgrade 2017-03-02 14:46:13 -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 Use bufio.Writer returned from hijack in upgrade 2017-03-02 14:46:13 -08:00
doc.go Add code snippet for EnableCompression in doc.go, change EnableWriteCompression()'s parameter to false since enableWriteCompression is true by default. 2017-01-26 10:48:11 -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
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 bufio.Writer returned from hijack in upgrade 2017-03-02 14:46:13 -08: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.

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.