docs: Fix typo. (#568)

1 file changed
tree: 7b7f4d275aa135920ee99409da87fe4b8014312e
  1. .circleci/
  2. .github/
  3. examples/
  4. .gitignore
  5. AUTHORS
  6. client.go
  7. client_clone.go
  8. client_clone_legacy.go
  9. client_server_test.go
  10. client_test.go
  11. compression.go
  12. compression_test.go
  13. conn.go
  14. conn_broadcast_test.go
  15. conn_test.go
  16. conn_write.go
  17. conn_write_legacy.go
  18. doc.go
  19. example_test.go
  20. go.mod
  21. go.sum
  22. join.go
  23. join_test.go
  24. json.go
  25. json_test.go
  26. LICENSE
  27. mask.go
  28. mask_safe.go
  29. mask_test.go
  30. prepared.go
  31. prepared_test.go
  32. proxy.go
  33. README.md
  34. server.go
  35. server_test.go
  36. trace.go
  37. trace_17.go
  38. util.go
  39. util_test.go
  40. x_net_proxy.go
README.md

Gorilla WebSocket

GoDoc CircleCI

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

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.