mirror of https://github.com/gorilla/websocket.git
629990daa3
<!-- For Work In Progress Pull Requests, please use the Draft PR feature, see https://github.blog/2019-02-14-introducing-draft-pull-requests/ for further details. For a timely review/response, please avoid force-pushing additional commits if your PR already received reviews or comments. Before submitting a Pull Request, please ensure that you have: - 📖 Read the Contributing guide: https://github.com/gorilla/.github/blob/main/CONTRIBUTING.md - 📖 Read the Code of Conduct: https://github.com/gorilla/.github/blob/main/CODE_OF_CONDUCT.md - Provide tests for your changes. - Use descriptive commit messages. - Comment your code where appropriate. - Squash your commits - Update any related documentation. - Add gorilla/pull-request-reviewers as a Reviewer --> ## What type of PR is this? (check all applicable) - [x] Refactor - [ ] Feature - [ ] Bug Fix - [ ] Optimization - [ ] Documentation Update - [ ] Go Version Update - [ ] Dependency Update ## Description ## Related Tickets & Documents <!-- For pull requests that relate or close an issue, please include them below. We like to follow [Github's guidance on linking issues to pull requests](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue). For example having the text: "closes #1234" would connect the current pull request to issue 1234. And when we merge the pull request, Github will automatically close the issue. --> - Related Issue # - Closes # ## Added/updated tests? - [ ] Yes - [x] No - [ ] I need help with writing tests ## Run verifications and test - [ ] `make verify` is passing - [ ] `make test` is passing |
||
|---|---|---|
| .github/workflows | ||
| examples | ||
| vendor | ||
| .editorconfig | ||
| .gitignore | ||
| .golangci.yml | ||
| LICENSE | ||
| Makefile | ||
| README.md | ||
| client.go | ||
| client_server_test.go | ||
| client_test.go | ||
| compression.go | ||
| compression_test.go | ||
| conn.go | ||
| conn_broadcast_test.go | ||
| conn_test.go | ||
| doc.go | ||
| example_test.go | ||
| go.mod | ||
| go.sum | ||
| join.go | ||
| join_test.go | ||
| json.go | ||
| json_test.go | ||
| mask.go | ||
| mask_safe.go | ||
| mask_test.go | ||
| prepared.go | ||
| prepared_test.go | ||
| proxy.go | ||
| server.go | ||
| server_test.go | ||
| tls_handshake.go | ||
| util.go | ||
| util_test.go | ||
README.md
gorilla/websocket
Gorilla WebSocket is a Go implementation of the WebSocket protocol.
Documentation
- API Reference
- Chat example
- Command example
- Client and server example
- File watch example
- Write buffer pool example
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.