A fast, well-tested and widely used WebSocket implementation for Go.
Go to file
Gary Burd a3ec486e6a Merge pull request #67 from cjellick/fix-typo
Fix typo
2015-05-29 20:03:52 -07:00
examples Fixed broken HTML for autobahn test server. 2014-12-24 03:15:18 -08:00
.gitignore Initial commit 2013-10-16 16:30:59 -07:00
.travis.yml Update Travis config, Go 1.0 not supported. 2013-12-23 11:41:02 -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 to use new path for Go sub-repos. 2014-11-10 09:56:46 -08:00
bench_test.go Add maskBytes benchmark. 2014-06-27 13:06:07 -07:00
client.go Reject URIs containing user information 2015-05-15 09:26:38 -07:00
client_server_test.go Allow separate specification of http/dial Hosts 2015-05-10 11:51:08 +01:00
client_test.go Reject URIs containing user information 2015-05-15 09:26:38 -07:00
conn.go Fix typo in comment 2015-04-18 13:58:37 +08:00
conn_test.go Improve errors. 2014-10-31 14:52:20 -07:00
doc.go Fix typo 2015-05-29 16:26:01 -07:00
json.go Improve the errors returned from ReadJSON. 2015-03-09 12:10:02 -07:00
json_test.go Improve the errors returned from ReadJSON. 2015-03-09 12:10:02 -07:00
server.go Improve server error messages 2015-01-14 22:19:51 -08:00
server_test.go Relicense to the Gorilla WebSocket Authors. 2014-04-18 14:25:11 -07:00
util.go Relicense to the Gorilla WebSocket Authors. 2014-04-18 14:25:11 -07:00
util_test.go Add test for function tokenListContainsValue 2014-11-17 04:16:34 -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 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
Limit size of received messageYesNo
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.