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

go golang gorilla gorilla-websocket websocket

Go to file

Gary Burd 5ed2f4547d Refactor client handshake - To take advantage of the Host header cleanup in the net/http Request.Write method, use a net/http Request to write the handshake to the wire. - Move code from the deprecated NewClientConn function to Dialer.Dial. This change makes it easier to add proxy support to Dialer.Dial. Add comment noting that NewClientConn is deprecated. - Update the code so that parseURL can be replaced with net/url Parse. We need to wait until we can require 1.5 before making the swap.		2015-10-21 10:08:33 -07:00
examples	Improve documentation	2015-10-19 15:05:01 -07: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	Add command example	2015-10-18 13:32:14 -07:00
bench_test.go	Add maskBytes benchmark.	2014-06-27 13:06:07 -07:00
client.go	Refactor client handshake	2015-10-21 10:08:33 -07:00
client_server_test.go	Refactor client handshake	2015-10-21 10:08:33 -07:00
client_test.go	Reject URIs containing user information	2015-05-15 09:26:38 -07:00
conn.go	Return write errors from default pong handler	2015-10-15 10:18:08 -07:00
conn_test.go	Add test for bufio.ReadBytes on connection reader	2015-10-08 22:47:23 -07:00
doc.go	Improve documentation	2015-10-19 15:05:01 -07: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
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 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
Limit size of received message	Yes	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.