xref: /aosp_15_r20/external/libwebsockets/lib/roles/http/compression/README.md (revision 1c60b9aca93fdbc9b5f19b2d2194c91294b22281)
1*1c60b9acSAndroid Build Coastguard WorkerHTTP compression
2*1c60b9acSAndroid Build Coastguard Worker----------------
3*1c60b9acSAndroid Build Coastguard Worker
4*1c60b9acSAndroid Build Coastguard WorkerThis directory contains generic compression transforms that can be applied to
5*1c60b9acSAndroid Build Coastguard Workerspecifically HTTP content streams, after the header, be it h1 or h2.
6*1c60b9acSAndroid Build Coastguard Worker
7*1c60b9acSAndroid Build Coastguard WorkerThe compression transforms expose an "ops" type struct and a compressor name
8*1c60b9acSAndroid Build Coastguard Workeras used by `content-encoding`... the ops struct definition can be found in
9*1c60b9acSAndroid Build Coastguard Worker./private-lib-roles-http-compression.h.
10*1c60b9acSAndroid Build Coastguard Worker
11*1c60b9acSAndroid Build Coastguard WorkerBecause the compression transform depends on being able to send on its output
12*1c60b9acSAndroid Build Coastguard Workerbefore it can process new input, the transform adds a new kind of buflist
13*1c60b9acSAndroid Build Coastguard Worker`wsi->buflist_comp` that represents pre-compression transform data
14*1c60b9acSAndroid Build Coastguard Worker("input data" from the perspective of the compression transform) that was
15*1c60b9acSAndroid Build Coastguard Workerdelivered to be processed but couldn't be accepted.
16*1c60b9acSAndroid Build Coastguard Worker
17*1c60b9acSAndroid Build Coastguard WorkerCurrently, zlib 'deflate' and brotli 'br' are supported on the server side.
18