2024-04-04 16:32:47 +03:00
|
|
|
# Gorilla WebSocket
|
2013-10-16 20:41:47 +04:00
|
|
|
|
2024-04-04 16:32:47 +03:00
|
|
|
[![GoDoc](https://godoc.org/github.com/gorilla/websocket?status.svg)](https://godoc.org/github.com/gorilla/websocket)
|
|
|
|
[![CircleCI](https://circleci.com/gh/gorilla/websocket.svg?style=svg)](https://circleci.com/gh/gorilla/websocket)
|
2019-06-29 21:55:28 +03:00
|
|
|
|
2024-04-04 16:32:47 +03:00
|
|
|
Gorilla WebSocket is a [Go](http://golang.org/) implementation of the
|
|
|
|
[WebSocket](http://www.rfc-editor.org/rfc/rfc6455.txt) protocol.
|
2013-10-16 20:41:47 +04:00
|
|
|
|
2022-01-04 04:49:10 +03:00
|
|
|
|
2013-10-29 17:29:20 +04:00
|
|
|
### Documentation
|
2013-10-16 20:41:47 +04:00
|
|
|
|
2020-03-19 16:46:16 +03:00
|
|
|
* [API Reference](https://pkg.go.dev/github.com/gorilla/websocket?tab=doc)
|
2023-11-08 21:57:41 +03:00
|
|
|
* [Chat example](https://github.com/gorilla/websocket/tree/main/examples/chat)
|
|
|
|
* [Command example](https://github.com/gorilla/websocket/tree/main/examples/command)
|
|
|
|
* [Client and server example](https://github.com/gorilla/websocket/tree/main/examples/echo)
|
|
|
|
* [File watch example](https://github.com/gorilla/websocket/tree/main/examples/filewatch)
|
|
|
|
* [Write buffer pool example](https://github.com/gorilla/websocket/tree/main/examples/bufferpool)
|
2013-10-16 20:41:47 +04:00
|
|
|
|
2013-10-29 17:29:20 +04:00
|
|
|
### Status
|
2013-10-16 20:41:47 +04:00
|
|
|
|
2013-10-29 17:29:20 +04:00
|
|
|
The Gorilla WebSocket package provides a complete and tested implementation of
|
|
|
|
the [WebSocket](http://www.rfc-editor.org/rfc/rfc6455.txt) protocol. The
|
2014-04-19 18:16:39 +04:00
|
|
|
package API is stable.
|
2013-10-16 20:41:47 +04:00
|
|
|
|
2013-10-29 17:29:20 +04:00
|
|
|
### Installation
|
2013-10-16 20:41:47 +04:00
|
|
|
|
|
|
|
go get github.com/gorilla/websocket
|
|
|
|
|
2013-10-29 17:29:20 +04:00
|
|
|
### Protocol Compliance
|
|
|
|
|
2014-04-21 08:14:06 +04:00
|
|
|
The Gorilla WebSocket package passes the server tests in the [Autobahn Test
|
2018-12-06 10:02:39 +03:00
|
|
|
Suite](https://github.com/crossbario/autobahn-testsuite) using the application in the [examples/autobahn
|
2024-04-04 16:32:47 +03:00
|
|
|
subdirectory](https://github.com/gorilla/websocket/tree/master/examples/autobahn).
|
|
|
|
|