re
/
websocket
forked from mirror/websocket
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
A fast, well-tested and widely used WebSocket implementation for Go.
8 Commits 2 Branches 9 Tags 942 KiB
Go 100%
Go to file
Gary Burd 93b1570a27 Improve documentation. 
- Introduce ReadMessage and WriteMessage before NextReader and
  NextWriter in the package comment. It's better to introduce the easy
  methods first.
- Move sections on message of types before the concurrency section.
 		2013-10-29 17:43:03 -07:00
examples Initial commit 2013-10-16 16:30:59 -07:00
.gitignore Initial commit 2013-10-16 16:30:59 -07:00
LICENSE Initial commit 2013-10-16 16:30:59 -07:00
README.md Add more information to README.md. 2013-10-29 06:31:06 -07:00
client.go Initial commit 2013-10-16 16:30:59 -07:00
client_server_test.go Initial commit 2013-10-16 16:30:59 -07:00
conn.go Improve documentation. 2013-10-27 08:34:33 -07:00
conn_test.go Initial commit 2013-10-16 16:30:59 -07:00
doc.go Improve documentation. 2013-10-29 17:43:03 -07:00
json.go Added WriteJSON/ReadJSON deprecated methods for backwards compatibility. 2013-10-27 18:27:32 -07:00
json_test.go Fix test for deprecated JSON funcs. 2013-10-27 18:33:40 -07:00
server.go Improve documentation. 2013-10-29 17:43:03 -07:00
server_test.go Add Subprotocols helper function. 2013-10-26 06:52:30 -07:00
util.go Initial commit 2013-10-16 16:30:59 -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 WebSockets Test Suite using the application in the examples/autobahn subdirectory.

Gorilla WebSocket compared with other packages

gorilla go.net
Protocol supportRFC 6455RFC 6455
Limit size of received messageYesNo
Send pings and receive pongsYesNo
Send close messageYesNo
Read message using io.ReaderYesNo, see note
Write message using io.WriteCloserYesNo, see note
Encode, decode JSON messageYesYes

Note: The go.net io.Reader and io.Writer operate across WebSocket message boundaries. Read returns when the input buffer is full or a message boundary is encountered, Each call to Write sends a message. The Gorilla io.Reader and io.WriteCloser operate on a single WebSocket message.