tree: 2535a41242ccd593a514a29ea1bfa6878788cee2 [path history] [tgz]
  1. .gitignore
  2. .travis.yml
  3. AUTHORS
  4. LICENSE
  5. README.md
  6. client.go
  7. client_clone.go
  8. client_clone_legacy.go
  9. compression.go
  10. conn.go
  11. conn_read.go
  12. conn_read_legacy.go
  13. doc.go
  14. json.go
  15. mask.go
  16. mask_safe.go
  17. prepared.go
  18. server.go
  19. util.go
vendor/github.com/gorilla/websocket/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

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.