41 lines
1.9 KiB
Markdown
41 lines
1.9 KiB
Markdown
|
# Fasthttp WebSocket
|
||
|
|
|
||
|
|
[](https://github.com/fasthttp/websocket/actions?workflow=test)
|
||
|
|
[](https://goreportcard.com/report/github.com/fasthttp/websocket)
|
||
|
|
[](https://pkg.go.dev/github.com/fasthttp/websocket)
|
||
|
|
[](https://github.com/fasthttp/websocket/releases)
|
||
|
|
|
||
|
|
WebSocket is a [Go](http://golang.org/) implementation of the [WebSocket](http://www.rfc-editor.org/rfc/rfc6455.txt) for [fasthttp](https://github.com/valyala/fasthttp).
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
_This project is a fork of the latest version of [gorilla/websocket](https://github.com/gorilla/websocket) that continues its development independently._
|
||
|
|
|
||
|
|
### Documentation
|
||
|
|
|
||
|
|
* [API Reference](https://pkg.go.dev/github.com/fasthttp/websocket?tab=doc)
|
||
|
|
* [Chat example](_examples/chat)
|
||
|
|
* [Command example](_examples/command)
|
||
|
|
* [Client and server example](_examples/echo)
|
||
|
|
* [File watch example](_examples/filewatch)
|
||
|
|
* [Write buffer pool example](_examples/bufferpool)
|
||
|
|
|
||
|
|
### Status
|
||
|
|
|
||
|
|
The 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/fasthttp/websocket
|
||
|
|
```
|
||
|
|
But beware that this will fetch the **latest commit of the master branch** which is never purposely broken, but usually not considered stable anyway.
|
||
|
|
|
||
|
|
### Protocol Compliance
|
||
|
|
|
||
|
|
The WebSocket package passes the server tests in the [Autobahn Test
|
||
|
|
Suite](https://github.com/crossbario/autobahn-testsuite) using the application in the [_examples/autobahn
|
||
|
|
subdirectory](_examples/autobahn).
|