2018-08-06 12:47:05 -07:00
|
|
|
# Gorilla WebSocket
|
|
|
|
|
|
2019-09-07 13:46:58 -07:00
|
|
|
[](https://godoc.org/github.com/gorilla/websocket)
|
|
|
|
|
[](https://circleci.com/gh/gorilla/websocket)
|
|
|
|
|
|
2018-08-06 12:47:05 -07:00
|
|
|
Gorilla WebSocket is a [Go](http://golang.org/) implementation of the
|
|
|
|
|
[WebSocket](http://www.rfc-editor.org/rfc/rfc6455.txt) protocol.
|
|
|
|
|
|
2022-03-12 10:41:07 -08:00
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
⚠️ **[The Gorilla WebSocket Package is looking for a new maintainer](https://github.com/gorilla/websocket/issues/370)**
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
2018-08-06 12:47:05 -07:00
|
|
|
### Documentation
|
|
|
|
|
|
2020-05-23 15:06:21 -07:00
|
|
|
* [API Reference](https://pkg.go.dev/github.com/gorilla/websocket?tab=doc)
|
2018-08-06 12:47:05 -07:00
|
|
|
* [Chat example](https://github.com/gorilla/websocket/tree/master/examples/chat)
|
|
|
|
|
* [Command example](https://github.com/gorilla/websocket/tree/master/examples/command)
|
|
|
|
|
* [Client and server example](https://github.com/gorilla/websocket/tree/master/examples/echo)
|
|
|
|
|
* [File watch example](https://github.com/gorilla/websocket/tree/master/examples/filewatch)
|
|
|
|
|
|
|
|
|
|
### Status
|
|
|
|
|
|
|
|
|
|
The Gorilla WebSocket package provides a complete and tested implementation of
|
|
|
|
|
the [WebSocket](http://www.rfc-editor.org/rfc/rfc6455.txt) 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
|
2019-09-07 13:46:58 -07:00
|
|
|
Suite](https://github.com/crossbario/autobahn-testsuite) using the application in the [examples/autobahn
|
2018-08-06 12:47:05 -07:00
|
|
|
subdirectory](https://github.com/gorilla/websocket/tree/master/examples/autobahn).
|
|
|
|
|
|
