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

Go to file

Gary Burd 02eec998da Improve documentation.		2014-10-31 14:51:45 -07:00
examples	fixed typo in comment	2014-09-11 08:36:21 +02: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.md	2014-06-05 13:56:06 -07:00
bench_test.go	Add maskBytes benchmark.	2014-06-27 13:06:07 -07:00
client.go	Improve client host header handling.	2014-05-08 11:21:56 -07:00
client_server_test.go	Cleanup client/server tests.	2014-07-05 08:49:11 -07:00
client_test.go	Improve client host header handling.	2014-05-08 11:21:56 -07:00
conn.go	Fix mask key.	2014-07-23 20:32:33 -07:00
conn_test.go	Cleanup EOF handling.	2014-07-10 19:36:51 -07:00
doc.go	Improve documentation.	2014-10-31 14:51:45 -07:00
json.go	Correct documentation, the "ReadJSON" function depends on "Unmarshal", not "Marshal"	2014-08-10 20:42:52 -05:00
json_test.go	Relicense to the Gorilla WebSocket Authors.	2014-04-18 14:25:11 -07:00
server.go	Check and handle error return from hijack.	2014-08-15 20:25:38 -07: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

Gorilla WebSocket

Gorilla WebSocket is a Go implementation of the WebSocket protocol.

The Gorilla WebSocket package provides a complete and tested implementation of the WebSocket protocol. The package API is stable.

go get github.com/gorilla/websocket

The Gorilla WebSocket package passes the server tests in the Autobahn Test Suite using the application in the examples/autobahn subdirectory.

	gorilla	go.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.