A fast, well-tested and widely used WebSocket implementation for Go.
Go to file
Gary Burd 1e6e1281b0 Clear upgrader handshake deadline. 2014-04-21 06:28:28 -07:00
examples Update readme files 2014-04-20 21:14:06 -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 readme. 2014-04-20 21:48:25 -07:00
client.go Relicense to the Gorilla WebSocket Authors. 2014-04-18 14:25:11 -07:00
client_server_test.go Use Upgrader in client/server test. 2014-04-20 12:08:24 -07:00
conn.go Cleanup issues reported by golint. 2014-04-20 07:20:03 -07:00
conn_test.go Cleanup issues reported by golint. 2014-04-20 07:20:03 -07:00
doc.go Various improvements to Upgrader. 2014-04-20 11:38:35 -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 Clear upgrader handshake deadline. 2014-04-21 06:28:28 -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 Test Suite using the application in the examples/autobahn subdirectory.

Gorilla WebSocket compared with other packages

gorilla go.net
RFC 6455 Features
Passes Autobahn Test SuiteYesNo
Receive fragmented messageYesNo
Send close messageYesNo
Send pings and receive pongsYesNo
Get the type of a received data messageYesYes, see note 2
Other Features
Limit size of received messageYesNo
Read message using io.ReaderYesNo, see note 1
Write message using io.WriteCloserYesNo, see note 1
Encode, decode JSON messageYesYes

Notes:

  1. 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.
  2. The application can get the type of a received data message by implementing a Codec marshal function.