Skip to content
A Gorilla WebSocket implementation for fasthttp.
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
examples
.gitignore
.travis.yml
AUTHORS Update AUTHORS and added Go Report Card badge Aug 26, 2018
LICENSE
README.md
client.go Add "in bytes" to sizes in documentation Oct 30, 2018
client_clone.go
client_clone_legacy.go
client_server_test.go
client_test.go Replace parseURL() with net/url.Parse() (#290) Oct 13, 2017
compression.go fix flate write pool size to work with best compression Jan 24, 2017
compression_test.go
conn.go Add "in bytes" to sizes in documentation Oct 30, 2018
conn_broadcast_test.go miscellaneous cleanup Aug 24, 2018
conn_test.go
conn_write.go
conn_write_legacy.go
doc.go Merge branch 'master' of https://github.com/gorilla/websocket Mar 11, 2019
example_test.go Fix imports in examples Aug 26, 2018
go.mod Upgrade fasthttp to v1.2.0 Feb 18, 2019
go.sum
join.go
join_test.go
json.go Misc cleanup Jul 18, 2017
json_test.go
mask.go Update with gofmt on tip Nov 23, 2017
mask_safe.go Add safe maskBytes Jan 1, 2017
mask_test.go
prepared.go miscellaneous cleanup Aug 24, 2018
prepared_test.go
proxy.go
server.go Merge branch 'master' of https://github.com/gorilla/websocket Nov 2, 2018
server_fasthttp.go Avoid defer Feb 6, 2019
server_test.go miscellaneous cleanup Aug 24, 2018
trace.go Add context in the Dialer Aug 24, 2018
trace_17.go Add context in the Dialer Aug 24, 2018
util.go
util_test.go
x_net_proxy.go Add SOCKS5 support Dec 1, 2017

README.md

Fasthttp Gorilla WebSocket

Build Status Go Report Card GoDoc GitHub release

Gorilla WebSocket is an implementation of the WebSocket protocol for the Go programming language.

This fork adds fasthttp support to the latest version of gorilla/websocket.

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/fasthttp/websocket

But beware that this will fetch the latest commit of the master branch which is never purposely broken, but usually not considered stable anyway.

Dep

If you're using dep, just use dep ensure to add a specific version of fasthttp/websocket including all its transitive dependencies to your project:

dep ensure -add github.com/fasthttp/websocket@v1.4.0

IMPORTANT: dep is only supported until version v1.4.0. In future versions will use Go modules.

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/fasthttp 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.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.