re
/
websocket
forked from mirror/websocket
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
A fast, well-tested and widely used WebSocket implementation for Go.
34 Commits 2 Branches 9 Tags 942 KiB
Go 100%
Go to file
Joachim Bauch f99474eb97 Renamed constants to match Go style guidelines. 2014-04-17 23:46:48 +02:00
examples Use new Upgrader API in examples 2014-04-16 17:42:15 +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
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 Renamed constants to match Go style guidelines. 2014-04-17 23:46:48 +02:00
server_test.go Add Subprotocols helper function. 2013-10-26 06:52:30 -07: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 supportRFC 6455RFC 6455
Limit size of received messageYesNo
Send pings and receive pongsYesNo
Send close messageYesNo
Read message using io.ReaderYesNo, see note
Write message using io.WriteCloserYesNo, see note
Encode, decode JSON messageYesYes

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.