Skip to content
A WebSocket implementation for Go.
Branch: master
Clone or download
Pull request Compare This branch is even with gorilla:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
examples
.gitignore
.travis.yml
AUTHORS
LICENSE
README.md
client.go
client_clone.go
client_clone_legacy.go
client_server_test.go
client_test.go
compression.go
compression_test.go
conn.go
conn_broadcast_test.go
conn_test.go
conn_write.go
conn_write_legacy.go
doc.go
example_test.go
go.mod
go.sum
join.go
join_test.go
json.go
json_test.go
mask.go
mask_safe.go
mask_test.go
prepared.go
prepared_test.go
proxy.go
server.go
server_test.go
trace.go
trace_17.go
util.go
util_test.go
x_net_proxy.go

README.md

Gorilla WebSocket

Gorilla WebSocket is a Go implementation of the WebSocket protocol.

Build Status GoDoc

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
Compression ExtensionsExperimentalNo
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.
You can’t perform that action at this time.