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.
64 Commits 4 Branches 11 Tags 3.1 MiB
Go 100%
Go to file
Gary Burd 10afcadf69 Cleanup EOF handling. 
- Modify data message reader to return io.ErrUnexpectedEOF if a close
  message is received before the final frame of the message.
- Modify NextReader to return io.ErrUnexpectedEOF if underlying
  connection returns io.EOF before a close message.
 		2014-07-10 19:36:51 -07:00
examples Improve chat example. 2014-06-27 13:08:22 -07:00
.gitignore Initial commit 2013-10-16 16:30:59 -07:00
.travis.yml Update Travis config, Go 1.0 not supported. 2013-12-23 11:41:02 -08: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.md 2014-06-05 13:56:06 -07:00
bench_test.go Add maskBytes benchmark. 2014-06-27 13:06:07 -07:00
client.go Improve client host header handling. 2014-05-08 11:21:56 -07:00
client_server_test.go Cleanup client/server tests. 2014-07-05 08:49:11 -07:00
client_test.go Improve client host header handling. 2014-05-08 11:21:56 -07:00
conn.go Cleanup EOF handling. 2014-07-10 19:36:51 -07:00
conn_test.go Cleanup EOF handling. 2014-07-10 19:36:51 -07:00
doc.go Add note about reading the connection. 2014-07-07 09:33:43 -07:00
json.go Relicense to the Gorilla WebSocket Authors. 2014-04-18 14:25:11 -07:00
json_test.go Relicense to the Gorilla WebSocket Authors. 2014-04-18 14:25:11 -07:00
server.go Relax default origin test. 2014-06-30 14:57:20 -07:00
server_test.go Relicense to the Gorilla WebSocket Authors. 2014-04-18 14:25:11 -07:00
util.go Relicense to the Gorilla WebSocket Authors. 2014-04-18 14:25:11 -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

gorilla go.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
Limit size of received messageYesNo
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.