https://github.com/gorilla/websocket.git

Gary Burd 10a95d14a3 Merge pull request #27 from AeroNotix/patch-1 11 years ago
examples b98fe92f10 Typo fix 11 years ago
.gitignore 273ecadfca Initial commit 12 years ago
.travis.yml c50896b0f1 Update Travis config, Go 1.0 not supported. 12 years ago
AUTHORS 15aed3b4a4 Relicense to the Gorilla WebSocket Authors. 11 years ago
LICENSE 15aed3b4a4 Relicense to the Gorilla WebSocket Authors. 11 years ago
README.md db1c080f90 Improve readme. 11 years ago
client.go db7a2a1679 Improve client host header handling. 11 years ago
client_server_test.go bbe4cde693 Use Upgrader in client/server test. 11 years ago
client_test.go db7a2a1679 Improve client host header handling. 11 years ago
conn.go f867cb5c72 Cleanup issues reported by golint. 11 years ago
conn_test.go f867cb5c72 Cleanup issues reported by golint. 11 years ago
doc.go df94ef6daa Various improvements to Upgrader. 11 years ago
json.go 15aed3b4a4 Relicense to the Gorilla WebSocket Authors. 11 years ago
json_test.go 15aed3b4a4 Relicense to the Gorilla WebSocket Authors. 11 years ago
server.go 1e6e1281b0 Clear upgrader handshake deadline. 11 years ago
server_test.go 15aed3b4a4 Relicense to the Gorilla WebSocket Authors. 11 years ago
util.go 15aed3b4a4 Relicense to the Gorilla WebSocket Authors. 11 years ago

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

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.
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