websocket/README.md

# Gorilla WebSocket

[![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)

Gorilla WebSocket is a [Go](http://golang.org/) implementation of the
[WebSocket](http://www.rfc-editor.org/rfc/rfc6455.txt) protocol.


### Documentation

* [API Reference](https://pkg.go.dev/github.com/gorilla/websocket?tab=doc)
* [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)
* [Write buffer pool example](https://github.com/gorilla/websocket/tree/master/examples/bufferpool)

### 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
Suite](https://github.com/crossbario/autobahn-testsuite) using the application in the [examples/autobahn
subdirectory](https://github.com/gorilla/websocket/tree/master/examples/autobahn).
Improve comparison with other packages in readme. 2014-04-19 18:16:39 +04:00			`# Gorilla WebSocket`
Initial commit 2013-10-16 20:41:47 +04:00
Create CircleCI config.yml (#519) * Create config.yml * Delete .travis.yml * Added CircleCI badge to README * Add golint; run on latest only 2019-06-29 21:55:28 +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)`

Add more information to README.md. 2013-10-29 17:29:20 +04:00			`Gorilla WebSocket is a [Go](http://golang.org/) implementation of the`
Initial commit 2013-10-16 20:41:47 +04:00			`[WebSocket](http://www.rfc-editor.org/rfc/rfc6455.txt) protocol.`

Update README (#757) - Note that a new maintainer is needed. - Remove comparison with x/net/websocket. There's no need to describe the issues with that package now that the package's documentation points people here and elsewhere. 2022-01-04 04:49:10 +03:00
Add more information to README.md. 2013-10-29 17:29:20 +04:00			`### Documentation`
Initial commit 2013-10-16 20:41:47 +04:00
Changed the link of API references to pkg.go.dev (#577) 2020-03-19 16:46:16 +03:00			`* [API Reference](https://pkg.go.dev/github.com/gorilla/websocket?tab=doc)`
Initial commit 2013-10-16 20:41:47 +04:00			`* [Chat example](https://github.com/gorilla/websocket/tree/master/examples/chat)`
Add command example 2015-10-18 23:32:14 +03:00			`* [Command example](https://github.com/gorilla/websocket/tree/master/examples/command)`
Add client and server example 2015-09-24 01:23:26 +03:00			`* [Client and server example](https://github.com/gorilla/websocket/tree/master/examples/echo)`
Various improvements to README files. 2014-03-21 00:26:28 +04:00			`* [File watch example](https://github.com/gorilla/websocket/tree/master/examples/filewatch)`
Correct way to save memory using write buffer pool and freeing net.http default buffers (#761) Summary of Changes 1. Add an example that uses the write buffer pool The loop process of the websocket connection is inner the http handler at existing examples， This usage will cause the 8k buffer(4k read buffer + 4k write buffer) allocated by net.http can't be GC(Observed by heap profiling, see picture below) . The purpose of saving memory is not achieved even if the WriteBufferPool is used. In example bufferpool, server process websocket connection in a new goroutine, and the goroutine created by the net.http will exit, then the 8k buffer will be GC. ![heap](https://user-images.githubusercontent.com/12793501/148676918-872d1a6d-ce10-4146-ba01-7de114db09f5.png) Co-authored-by: hakunaliu <hakunaliu@tencent.com> Co-authored-by: Corey Daley <cdaley@redhat.com> 2023-08-17 18:25:09 +03:00			`* [Write buffer pool example](https://github.com/gorilla/websocket/tree/master/examples/bufferpool)`
Initial commit 2013-10-16 20:41:47 +04:00
Add more information to README.md. 2013-10-29 17:29:20 +04:00			`### Status`
Initial commit 2013-10-16 20:41:47 +04:00
Add more information to README.md. 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`
Improve comparison with other packages in readme. 2014-04-19 18:16:39 +04:00			`package API is stable.`
Initial commit 2013-10-16 20:41:47 +04:00
Add more information to README.md. 2013-10-29 17:29:20 +04:00			`### Installation`
Initial commit 2013-10-16 20:41:47 +04:00
			`go get github.com/gorilla/websocket`

Add more information to README.md. 2013-10-29 17:29:20 +04:00			`### Protocol Compliance`

Update readme files - Improve comparison with go.net package. - Improve autobahn server description. 2014-04-21 08:14:06 +04:00			`The Gorilla WebSocket package passes the server tests in the [Autobahn Test`
Updated autobahn test suite URL Fixes #436 2018-12-06 10:02:39 +03:00			`Suite](https://github.com/crossbario/autobahn-testsuite) using the application in the [examples/autobahn`
Add more information to README.md. 2013-10-29 17:29:20 +04:00			`subdirectory](https://github.com/gorilla/websocket/tree/master/examples/autobahn).`