xref: /aosp_15_r20/external/cronet/net/websockets/README.md (revision 6777b5387eb2ff775bb5750e3f5d96f37fb7352b)
1# WebSocket protocol
2
3This directory contains the implementation of
4[the WebSocket protocol](https://tools.ietf.org/html/rfc6455).
5
6## Design docs
7
8* [WebSocketBasicHandshakeStream design
9  memo](https://docs.google.com/document/d/1r7dQDA9AQBD_kOk-z-yMi0WgLQZ-5m7psMO5pYLFUL8/edit).
10  Some details have changed, but still a mostly-accurate description of
11  Chromium's current implementation.
12* [WebSocket Throttling
13  Design](https://docs.google.com/document/d/1a8sUFQsbN5uve7ziW61ATkrFr3o9A-Tiyw8ig6T3puA/edit)
14  discusses how we enforce WebSocket connection throttling. Also contains
15  detailed discussion of how WebSockets integrate with the socket pools. Dates
16  from 2014, but still mostly relevant.
17* [WebSockets over
18  HTTP/2](https://docs.google.com/document/d/1ZxaHz4j2BDMa1aI5CQHMjtFI3UxGT459pjYv4To9rFY/edit).
19  Current as of 2019 description of WebSocket over H/2 implementation.
20* [WebSocket + Network Service + WebRequest
21  API](https://docs.google.com/document/d/1L85aXX-m5NaV-g223lH7kKB2HPg6kMi1cjrDVeEptE8/edit):
22  design for how extension callbacks are called when the network service is
23  enabled.
24* [WebSocket HTTP Auth
25  Design](https://docs.google.com/document/d/129rLtf5x3hvhP5rayLiSxnEjOXS8Z7EnLJgBL4CdwjI/edit).
26  This document is very low on detail, but can serve as an overview of how auth
27  works for WebSockets.
28* [Per-renderer WebSocket
29  throttling](https://docs.google.com/document/d/1aw2oN5PKfk-1gLnBrlv1OwLA8K3-ykM2ckwX2lubTg4/edit).
30  While the algorithm described in this document is still used, the code has
31  moved around significantly due to network servicification.
32* [WebSocket Protocol Stack in
33  chrome/net](https://docs.google.com/document/d/11n3hpwb9lD9YVqnjX3OwzE_jHgTmKIqd6GvXE9bDGUg/edit).
34  Early design doc for the current implementation. Mostly of historical interest
35  only.
36