mirror
/
websocket
mirror of https://github.com/gorilla/websocket.git
1
0
Fork 1
Code Issues Packages Projects Releases Wiki Activity
A fast, well-tested and widely used WebSocket implementation for Go.
42 Commits 4 Branches 11 Tags 3.2 MiB
Go 100%
Go to file
Gary Burd f5c69ea9ed Improve comparison with other packages in readme. 2014-04-19 07:16:39 -07:00
examples Relicense to the Gorilla WebSocket Authors. 2014-04-18 14:25:11 -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 Improve comparison with other packages in readme. 2014-04-19 07:16:39 -07:00
client.go Relicense to the Gorilla WebSocket Authors. 2014-04-18 14:25:11 -07:00
client_server_test.go Relicense to the Gorilla WebSocket Authors. 2014-04-18 14:25:11 -07:00
conn.go Relicense to the Gorilla WebSocket Authors. 2014-04-18 14:25:11 -07:00
conn_test.go Relicense to the Gorilla WebSocket Authors. 2014-04-18 14:25:11 -07:00
doc.go Relicense to the Gorilla WebSocket Authors. 2014-04-18 14:25:11 -07:00
json.go Relicense to the Gorilla WebSocket Authors. 2014-04-18 14:25:11 -07:00
json_test.go Relicense to the Gorilla WebSocket Authors. 2014-04-18 14:25:11 -07:00
server.go Relicense to the Gorilla WebSocket Authors. 2014-04-18 14:25:11 -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

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, see notes
Limit size of received messageYesNo
Send pings and receive pongsYesNo
Send close messageYesNo
Read message using io.ReaderYesNo, see notes
Write message using io.WriteCloserYesNo, see notes
Encode, decode JSON messageYesYes

Notes:

  • The go.net package does not handle fragmented messages.
  • 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.