mirror
/
websocket
mirror of https://github.com/gorilla/websocket.git
1
0
Fork 1
Code Issues Packages Projects Releases Wiki Activity
A fast, well-tested and widely used WebSocket implementation for Go.
167 Commits 4 Branches 11 Tags 3.2 MiB
Go 100%
Go to file
Artyom Pervukhin 99ffb988ce Update README to reflect change of Go sub-repo websocket feature 
Closes #164
 		2016-10-17 11:17:13 +03:00
examples Fix typos in chat example 2016-08-02 07:24:52 +01:00
.gitignore Meaningful names for hub 2016-05-18 08:56:16 -06:00
.travis.yml Revert "Reduce memory allocations in NextReader, NextWriter" 2016-05-30 01:53:33 -07:00
AUTHORS Relicense to the Gorilla WebSocket Authors. 2014-04-18 14:25:11 -07:00
LICENSE Relicense to the Gorilla WebSocket Authors. 2014-04-18 14:25:11 -07:00
README.md Update README to reflect change of Go sub-repo websocket feature 2016-10-17 11:17:13 +03:00
bench_test.go Add maskBytes benchmark. 2014-06-27 13:06:07 -07:00
client.go Do not shallow copy crypto/tls.Config 2016-04-23 15:46:58 -07:00
client_server_test.go Simplify dial TLS test 2016-09-12 08:30:41 -07:00
client_test.go Split raw query from opaque in URL parser 2015-12-15 21:10:58 -08:00
compression.go Add hooks to support RFC 7692 (per-message compression extension) 2016-06-29 17:03:55 -07:00
compression_test.go Add hooks to support RFC 7692 (per-message compression extension) 2016-06-29 17:03:55 -07:00
conn.go Add hooks to support RFC 7692 (per-message compression extension) 2016-06-29 17:03:55 -07:00
conn_read.go Reduce memory allocations in NextReader, NextWriter 2016-05-31 05:44:45 -07:00
conn_read_legacy.go Reduce memory allocations in NextReader, NextWriter 2016-05-31 05:44:45 -07:00
conn_test.go Test truncated frames at all positions 2016-04-25 08:42:53 -07:00
doc.go Document that default ping handler can block 2016-03-13 12:14:46 -07:00
example_test.go Fix go vet warning 2016-03-02 14:56:29 -08:00
json.go Provide all close frame data to application 2015-08-11 10:14:32 -07:00
json_test.go Provide all close frame data to application 2015-08-11 10:14:32 -07:00
server.go Implement RFC 6455, section 4.4 2016-06-29 13:56:55 -07:00
server_test.go Add IsWebSocketUpgrade 2016-03-09 10:36:44 -08:00
util.go Add Sec-WebSocket-Extensions header parser 2016-05-31 09:32:45 -07:00
util_test.go Add Sec-WebSocket-Extensions header parser 2016-05-31 09:32:45 -07:00

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

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