Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[pull] master from gorilla:master #2

Open
wants to merge 32 commits into
base: master
Choose a base branch
from
Open
Changes from 1 commit
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
7e9819d
fix typos (#532)
xiaobogaga Aug 23, 2019
5b740c2
Read Limit Fix (#537)
elithrar Aug 25, 2019
c3e18be
Create release-drafter.yml (#538)
elithrar Aug 25, 2019
836e821
Changed the link of API references to pkg.go.dev (#577)
thearyanahmed Mar 19, 2020
ed9368d
typo (#583)
dbaker-arch Mar 19, 2020
0a093fc
Fix a couple of small typo's (#567)
Mar 19, 2020
e90f6db
input autofocus (#564)
codenoid Mar 19, 2020
015e196
Use empty struct to protect writing (#566)
ferhatelmas Mar 19, 2020
81cef7d
echo example: handle received messages as text, not HTML (#563)
Mar 19, 2020
d113569
Duration order consistency when multiplying number by time unit (#570)
maxifom Mar 19, 2020
8c288dc
docs: Fix typo. (#568)
jongillham Mar 19, 2020
b65e629
build: clean up go.sum (#584)
elithrar Mar 19, 2020
873e67e
Fix how the client checks for presence of Upgrade: websocket, Connect…
bluetech Aug 20, 2020
78ab81e
docs: clarify that sub protocols are not set via responseHeader arg.
elithrar Aug 22, 2020
c3dd95a
build: use build matrix; drop Go <= 1.10 (#629)
elithrar Sep 12, 2020
e8629af
improve echo example (#671)
hellflame Apr 24, 2021
b4b5d88
Document the allowed concurrency on Upgrader and Dialer (#636)
garyburd Dec 16, 2021
1905f7e
Update source to match output from gofmt 1.17
garyburd Dec 18, 2021
2c89656
Modify http Method String Literal to Variable (#728)
thak1411 Dec 19, 2021
bcef843
Use context.Context in TLS handshake (#751)
garyburd Jan 1, 2022
beca1d3
Fix broadcast benchmarks (#542)
Jan 2, 2022
2d6ee4c
Update autobahn example
garyburd Jan 2, 2022
f0643a3
Improve protocol error messages
garyburd Jan 2, 2022
4fad403
Remove support for Go 1.8
garyburd Jan 2, 2022
2f25f78
Update README (#757)
garyburd Jan 4, 2022
9111bb8
Dialer: add optional method NetDialTLSContext (#746)
lluiscampos Jan 4, 2022
69d0eb9
Add check for Sec-WebSocket-Key header (#752)
hirasawayuki Feb 16, 2022
78cf1bc
Changed the method name UnderlyingConn to NetConn to align the method…
JWSong Apr 17, 2022
27d91a9
drop the versions of go that are no longer supported + add 1.18 to ci
Jun 20, 2022
bc7ce89
Check for and report bad protocol in TLSClientConfig.NextProtos (#788)
ChannyClaus Jun 21, 2022
af47554
check error before GotConn for trace
junnplus Jul 6, 2022
76ecc29
archive mode
elithrar Dec 9, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update README (gorilla#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.
  • Loading branch information
garyburd authored Jan 4, 2022
commit 2f25f7843d3d0e4889e5e008dcbdd77fec378deb
39 changes: 7 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
@@ -6,6 +6,13 @@
Gorilla WebSocket is a [Go](http://golang.org/) implementation of the
[WebSocket](http://www.rfc-editor.org/rfc/rfc6455.txt) protocol.


---

⚠️ **[The Gorilla WebSocket Package is looking for a new maintainer](https://github.com/gorilla/websocket/issues/370)**

---

### Documentation

* [API Reference](https://pkg.go.dev/github.com/gorilla/websocket?tab=doc)
@@ -30,35 +37,3 @@ 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).

### Gorilla WebSocket compared with other packages

<table>
<tr>
<th></th>
<th><a href="http://godoc.org/github.com/gorilla/websocket">github.com/gorilla</a></th>
<th><a href="http://godoc.org/golang.org/x/net/websocket">golang.org/x/net</a></th>
</tr>
<tr>
<tr><td colspan="3"><a href="http://tools.ietf.org/html/rfc6455">RFC 6455</a> Features</td></tr>
<tr><td>Passes <a href="https://github.com/crossbario/autobahn-testsuite">Autobahn Test Suite</a></td><td><a href="https://github.com/gorilla/websocket/tree/master/examples/autobahn">Yes</a></td><td>No</td></tr>
<tr><td>Receive <a href="https://tools.ietf.org/html/rfc6455#section-5.4">fragmented</a> message<td>Yes</td><td><a href="https://code.google.com/p/go/issues/detail?id=7632">No</a>, see note 1</td></tr>
<tr><td>Send <a href="https://tools.ietf.org/html/rfc6455#section-5.5.1">close</a> message</td><td><a href="http://godoc.org/github.com/gorilla/websocket#hdr-Control_Messages">Yes</a></td><td><a href="https://code.google.com/p/go/issues/detail?id=4588">No</a></td></tr>
<tr><td>Send <a href="https://tools.ietf.org/html/rfc6455#section-5.5.2">pings</a> and receive <a href="https://tools.ietf.org/html/rfc6455#section-5.5.3">pongs</a></td><td><a href="http://godoc.org/github.com/gorilla/websocket#hdr-Control_Messages">Yes</a></td><td>No</td></tr>
<tr><td>Get the <a href="https://tools.ietf.org/html/rfc6455#section-5.6">type</a> of a received data message</td><td>Yes</td><td>Yes, see note 2</td></tr>
<tr><td colspan="3">Other Features</tr></td>
<tr><td><a href="https://tools.ietf.org/html/rfc7692">Compression Extensions</a></td><td>Experimental</td><td>No</td></tr>
<tr><td>Read message using io.Reader</td><td><a href="http://godoc.org/github.com/gorilla/websocket#Conn.NextReader">Yes</a></td><td>No, see note 3</td></tr>
<tr><td>Write message using io.WriteCloser</td><td><a href="http://godoc.org/github.com/gorilla/websocket#Conn.NextWriter">Yes</a></td><td>No, see note 3</td></tr>
</table>

Notes:

1. Large messages are fragmented in [Chrome's new WebSocket implementation](http://www.ietf.org/mail-archive/web/hybi/current/msg10503.html).
2. The application can get the type of a received data message by implementing
a [Codec marshal](http://godoc.org/golang.org/x/net/websocket#Codec.Marshal)
function.
3. 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.