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

Go to file

Joachim Bauch b2f990180a Implement Upgrader API (#6 ).		2014-04-16 17:25:17 +02:00
examples	Various improvements to README files.	2014-03-20 13:26:28 -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
LICENSE	Initial commit	2013-10-16 16:30:59 -07:00
README.md	Various improvements to README files.	2014-03-20 13:26:28 -07:00
client.go	Cleanup issues reported by golint.	2013-12-23 12:08:49 -08:00
client_server_test.go	Add subprotocol negotiation to Dialer.	2013-12-14 08:06:24 -08:00
conn.go	Added helper function UnderlyingConn to retrieve net.Conn from Conn objects.	2014-03-18 15:26:10 +01:00
conn_test.go	Added helper function UnderlyingConn to retrieve net.Conn from Conn objects.	2014-03-18 15:26:10 +01:00
doc.go	Fix small inconsistency in example.	2014-02-15 13:48:14 +01:00
json.go	Cleanup issues reported by golint.	2013-12-23 12:08:49 -08:00
json_test.go	Fix test for deprecated JSON funcs.	2013-10-27 18:33:40 -07:00
server.go	Implement Upgrader API (#6 ).	2014-04-16 17:25:17 +02:00
server_test.go	Add Subprotocols helper function.	2013-10-26 06:52:30 -07:00
upgrader.go	Implement Upgrader API (#6 ).	2014-04-16 17:25:17 +02:00
util.go	Initial commit	2013-10-16 16:30:59 -07: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 WebSockets Test Suite using the application in the examples/autobahn subdirectory.

Gorilla WebSocket compared with other packages

	gorilla	go.net
Protocol support	RFC 6455	RFC 6455
Limit size of received message	Yes	No
Send pings and receive pongs	Yes	No
Send close message	Yes	No
Read message using io.Reader	Yes	No, see note
Write message using io.WriteCloser	Yes	No, see note
Encode, decode JSON message	Yes	Yes

Note: The go.net io.Reader and io.Writer operate across WebSocket message boundaries. Read returns when the input buffer is full or a message boundary is encountered, Each call to Write sends a message. The Gorilla io.Reader and io.WriteCloser operate on a single WebSocket message.