A fast, well-tested and widely used WebSocket implementation for Go.

Go to file

Steven Scott b378caee5b Add write buffer pooling Add WriteBufferPool to Dialer and Upgrader. This field specifies a pool to use for write operations on a connection. Use of the pool can reduce memory use when there is a modest write volume over a large number of connections. Use larger of hijacked buffer and buffer allocated for connection (if any) as buffer for building handshake response. This decreases possible allocations when building the handshake response. Modify bufio reuse test to call Upgrade instead of the internal newConnBRW. Move the test from conn_test.go to server_test.go because it's a serer test. Update newConn and newConnBRW: - Move the bufio "hacks" from newConnBRW to separate functions and call these functions directly from Upgrade. - Rename newConn to newTestConn and move to conn_test.go. Shorten argument list to common use case. - Rename newConnBRW to newConn. - Add pool code to newConn.		2018-08-22 14:11:59 -07:00
examples	Minor fixes in comments	2018-04-15 20:20:28 -07:00
.gitignore	add newline and remove extra space	2018-03-04 15:22:45 -08:00
.travis.yml	drop Go versions prior to 1.7 in CI	2018-08-22 14:10:37 -07:00
AUTHORS	Update LICENSE file to reflect Google employee contributions.	2018-06-05 13:25:52 -07:00
LICENSE	Relicense to the Gorilla WebSocket Authors.	2014-04-18 14:25:11 -07:00
README.md	add newline and remove extra space	2018-03-04 15:22:45 -08:00
client.go	Add write buffer pooling	2018-08-22 14:11:59 -07:00
client_clone.go	Update cloneTLSConfig to use Go 1.8 Config.Clone method	2017-02-18 08:27:10 -08:00
client_clone_legacy.go	Update cloneTLSConfig to use Go 1.8 Config.Clone method	2017-02-18 08:27:10 -08:00
client_server_test.go	Improve names in handshake deadline test	2018-05-28 12:07:56 -07:00
client_test.go	Replace parseURL() with net/url.Parse() (#290 )	2017-10-12 19:08:58 -07:00
compression.go	fix flate write pool size to work with best compression	2017-01-25 02:15:04 +03:00
compression_test.go	Add write buffer pooling	2018-08-22 14:11:59 -07:00
conn.go	Add write buffer pooling	2018-08-22 14:11:59 -07:00
conn_broadcast_test.go	Add write buffer pooling	2018-08-22 14:11:59 -07:00
conn_test.go	Add write buffer pooling	2018-08-22 14:11:59 -07:00
conn_write.go	Use net.Buffers to write multiple slices to connection	2018-03-06 10:15:48 -08:00
conn_write_legacy.go	Use net.Buffers to write multiple slices to connection	2018-03-06 10:15:48 -08:00
doc.go	Improve check origin documentation	2018-01-25 10:51:21 -08:00
example_test.go	Fix go vet warning	2016-03-02 14:56:29 -08:00
json.go	Misc cleanup	2017-07-18 13:21:30 -07:00
json_test.go	Add write buffer pooling	2018-08-22 14:11:59 -07:00
mask.go	Update with gofmt on tip	2017-11-23 00:11:29 -08:00
mask_safe.go	Add safe maskBytes	2016-12-31 20:13:41 -08:00
mask_test.go	Add safe maskBytes	2016-12-31 20:13:41 -08:00
prepared.go	Prepared Messages (#211 )	2017-02-14 09:41:18 -08:00
prepared_test.go	Add write buffer pooling	2018-08-22 14:11:59 -07:00
proxy.go	Minor fixes in comments	2018-04-15 20:20:28 -07:00
server.go	Add write buffer pooling	2018-08-22 14:11:59 -07:00
server_test.go	Add write buffer pooling	2018-08-22 14:11:59 -07:00
util.go	Update with gofmt on tip	2017-11-23 00:11:29 -08:00
util_test.go	Add parseExtensions test case (#310 )	2017-12-05 11:45:40 -08:00
x_net_proxy.go	Add SOCKS5 support	2017-11-30 17:43:01 -08:00

README.md

Gorilla WebSocket

Gorilla WebSocket is a Go implementation of the WebSocket protocol.

Documentation

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.

Gorilla WebSocket compared with other packages

	github.com/gorilla	golang.org/x/net
RFC 6455 Features
Passes Autobahn Test Suite	Yes	No
Receive fragmented message	Yes	No, see note 1
Send close message	Yes	No
Send pings and receive pongs	Yes	No
Get the type of a received data message	Yes	Yes, see note 2
Other Features
Compression Extensions	Experimental	No
Read message using io.Reader	Yes	No, see note 3
Write message using io.WriteCloser	Yes	No, see note 3

Notes:

Large messages are fragmented in Chrome's new WebSocket implementation.
The application can get the type of a received data message by implementing a Codec marshal function.
The go.net io.Reader and io.Writer operate across WebSocket frame boundaries. Read returns when the input buffer is full or a frame boundary is encountered. Each call to Write sends a single frame message. The Gorilla io.Reader and io.WriteCloser operate on a single WebSocket message.