cloudflared-mirror/vendor/github.com/gorilla/websocket
Areg Harutyunyan 0468866626 TUN-813: Clean up cloudflared dependencies 2018-07-24 18:07:02 -05:00
..
.gitignore TUN-528: Move cloudflared into a separate repo 2018-07-19 15:02:24 -05:00
.travis.yml TUN-528: Move cloudflared into a separate repo 2018-07-19 15:02:24 -05:00
AUTHORS TUN-528: Move cloudflared into a separate repo 2018-07-19 15:02:24 -05:00
LICENSE TUN-528: Move cloudflared into a separate repo 2018-07-19 15:02:24 -05:00
README.md TUN-528: Move cloudflared into a separate repo 2018-07-19 15:02:24 -05:00
client.go TUN-528: Move cloudflared into a separate repo 2018-07-19 15:02:24 -05:00
client_clone.go TUN-528: Move cloudflared into a separate repo 2018-07-19 15:02:24 -05:00
client_clone_legacy.go TUN-528: Move cloudflared into a separate repo 2018-07-19 15:02:24 -05:00
compression.go TUN-528: Move cloudflared into a separate repo 2018-07-19 15:02:24 -05:00
conn.go TUN-528: Move cloudflared into a separate repo 2018-07-19 15:02:24 -05:00
conn_read.go TUN-528: Move cloudflared into a separate repo 2018-07-19 15:02:24 -05:00
conn_read_legacy.go TUN-528: Move cloudflared into a separate repo 2018-07-19 15:02:24 -05:00
doc.go TUN-528: Move cloudflared into a separate repo 2018-07-19 15:02:24 -05:00
json.go TUN-528: Move cloudflared into a separate repo 2018-07-19 15:02:24 -05:00
mask.go TUN-528: Move cloudflared into a separate repo 2018-07-19 15:02:24 -05:00
mask_safe.go TUN-528: Move cloudflared into a separate repo 2018-07-19 15:02:24 -05:00
prepared.go TUN-528: Move cloudflared into a separate repo 2018-07-19 15:02:24 -05:00
server.go TUN-528: Move cloudflared into a separate repo 2018-07-19 15:02:24 -05:00
util.go TUN-528: Move cloudflared into a separate repo 2018-07-19 15:02:24 -05:00

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.