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

Gary Burd 82a29af075 Update readme files 11 years ago
examples 82a29af075 Update readme files 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 82a29af075 Update readme files 11 years ago
client.go 15aed3b4a4 Relicense to the Gorilla WebSocket Authors. 11 years ago
client_server_test.go bbe4cde693 Use Upgrader in client/server test. 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 df94ef6daa Various improvements to Upgrader. 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

gorilla go.net
RFC 6455 Features
Passes Autobahn Test SuiteYesNo
Receive fragmented messageYesNo
Send close messageYesNo
Send pings and receive pongsYesNo
Other Features
Limit size of received 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 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.