woodpecker/vendor/github.com/gorilla/websocket
2016-05-23 14:41:01 -07:00
..
AUTHORS updated vendored deps 2016-05-23 14:41:01 -07:00
client.go updated vendored deps 2016-05-23 14:41:01 -07:00
conn.go updated vendored deps 2016-05-23 14:41:01 -07:00
doc.go updated vendored deps 2016-05-23 14:41:01 -07:00
json.go updated vendored deps 2016-05-23 14:41:01 -07:00
LICENSE updated vendored deps 2016-05-23 14:41:01 -07:00
README.md updated vendored deps 2016-05-23 14:41:01 -07:00
server.go updated vendored deps 2016-05-23 14:41:01 -07:00
util.go updated vendored deps 2016-05-23 14:41:01 -07:00

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

github.com/gorilla golang.org/x/net
RFC 6455 Features
Passes Autobahn Test SuiteYesNo
Receive fragmented messageYesNo, see note 1
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 3
Write message using io.WriteCloserYesNo, see note 3

Notes:

  1. Large messages are fragmented in Chrome's new WebSocket implementation.
  2. The application can get the type of a received data message by implementing a Codec marshal function.
  3. 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.