GoToSocial/vendor/github.com/gorilla/websocket
tobi f2e5bedea6
migrate go version to 1.17 (#203)
* migrate go version to 1.17

* update contributing
2021-09-10 14:42:14 +02:00
..
.gitignore Grand test fixup (#138) 2021-08-12 21:03:24 +02:00
AUTHORS Grand test fixup (#138) 2021-08-12 21:03:24 +02:00
LICENSE Grand test fixup (#138) 2021-08-12 21:03:24 +02:00
README.md Grand test fixup (#138) 2021-08-12 21:03:24 +02:00
client.go Grand test fixup (#138) 2021-08-12 21:03:24 +02:00
client_clone.go Grand test fixup (#138) 2021-08-12 21:03:24 +02:00
client_clone_legacy.go Grand test fixup (#138) 2021-08-12 21:03:24 +02:00
compression.go Grand test fixup (#138) 2021-08-12 21:03:24 +02:00
conn.go Grand test fixup (#138) 2021-08-12 21:03:24 +02:00
conn_write.go Grand test fixup (#138) 2021-08-12 21:03:24 +02:00
conn_write_legacy.go Grand test fixup (#138) 2021-08-12 21:03:24 +02:00
doc.go Grand test fixup (#138) 2021-08-12 21:03:24 +02:00
join.go Grand test fixup (#138) 2021-08-12 21:03:24 +02:00
json.go Grand test fixup (#138) 2021-08-12 21:03:24 +02:00
mask.go Grand test fixup (#138) 2021-08-12 21:03:24 +02:00
mask_safe.go Grand test fixup (#138) 2021-08-12 21:03:24 +02:00
prepared.go Grand test fixup (#138) 2021-08-12 21:03:24 +02:00
proxy.go Grand test fixup (#138) 2021-08-12 21:03:24 +02:00
server.go Grand test fixup (#138) 2021-08-12 21:03:24 +02:00
trace.go Grand test fixup (#138) 2021-08-12 21:03:24 +02:00
trace_17.go Grand test fixup (#138) 2021-08-12 21:03:24 +02:00
util.go Grand test fixup (#138) 2021-08-12 21:03:24 +02:00
x_net_proxy.go Grand test fixup (#138) 2021-08-12 21:03:24 +02:00

README.md

Gorilla WebSocket

GoDoc CircleCI

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