Improve server subprotocol documentation

Partial fix for 404.
1 file changed
tree: 2d8ee711c05d10fe35c3e39185c042342aed3f55
  1. examples/
  2. .gitignore
  3. .travis.yml
  5. client.go
  6. client_clone.go
  7. client_clone_legacy.go
  8. client_server_test.go
  9. client_test.go
  10. compression.go
  11. compression_test.go
  12. conn.go
  13. conn_broadcast_test.go
  14. conn_read.go
  15. conn_read_legacy.go
  16. conn_test.go
  17. conn_write.go
  18. conn_write_legacy.go
  19. doc.go
  20. example_test.go
  21. json.go
  22. json_test.go
  24. mask.go
  25. mask_safe.go
  26. mask_test.go
  27. prepared.go
  28. prepared_test.go
  29. proxy.go
  31. server.go
  32. server_test.go
  33. util.go
  34. util_test.go
  35. x_net_proxy.go

Gorilla WebSocket

Gorilla WebSocket is a Go implementation of the WebSocket protocol.

Build Status GoDoc



The Gorilla WebSocket package provides a complete and tested implementation of the WebSocket protocol. The package API is stable.


go get

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


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