umgeher/cowboy
0
Fork 0
mirror of https://github.com/ninenines/cowboy.git synced 2025-07-15 12:40:25 +00:00
Code Issues Wiki Activity

Add cowboy_decompress_h stream handler

Browse source
This commit is contained in:
jdamanalo 2023-03-31 15:56:23 +08:00 • committed by Loïc Hoguin
parent ffbcdf534c
commit 3ed1b24dd6
No known key found for this signature in database
GPG key ID: 8A9DF795F6FED764
10 changed files with 680 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

1
doc/src/manual/cowboy_compress_h.asciidoc
View file

@ -63,6 +63,7 @@ The compress stream handler does not produce any event.
link:man:cowboy(7)[cowboy(7)],
link:man:cowboy_stream(3)[cowboy_stream(3)],
link:man:cowboy_decompress_h(3)[cowboy_decompress_h(3)],
link:man:cowboy_metrics_h(3)[cowboy_metrics_h(3)],
link:man:cowboy_stream_h(3)[cowboy_stream_h(3)],
link:man:cowboy_tracer_h(3)[cowboy_tracer_h(3)]

58
doc/src/manual/cowboy_decompress_h.asciidoc Normal file
View file

@ -0,0 +1,58 @@
= cowboy_decompress_h(3)
== Name
cowboy_decompress_h - Decompress stream handler
== Description
The module `cowboy_decompress_h` decompresses request bodies
automatically when the server supports it. Requests will
only be decompressed when their compression ratio is lower
than the configured limit. Mismatch of the content and
`content-encoding` is rejected with `400 Bad Request`.
== Options
[source,erlang]
----
opts() :: #{
decompress_ratio_limit => non_neg_integer(),
decompress_ignore => boolean()
}
----
Configuration for the decompress stream handler.
The default value is given next to the option name:
decompress_ratio_limit (20)::
The max ratio of the compressed and decompressed body
before it is rejected with `413 Payload Too Large`.
+
This option can be updated at any time using the
`set_options` stream handler command.
decompress_ignore (false)::
Whether the handler will be ignored.
+
This option can be updated at any time using the
`set_options` stream handler command.
== Events
The decompress stream handler does not produce any event.
== Changelog
* *2.11*: Module introduced.
== See also
link:man:cowboy(7)[cowboy(7)],
link:man:cowboy_stream(3)[cowboy_stream(3)],
link:man:cowboy_compress_h(3)[cowboy_compress_h(3)],
link:man:cowboy_metrics_h(3)[cowboy_metrics_h(3)],
link:man:cowboy_stream_h(3)[cowboy_stream_h(3)],
link:man:cowboy_tracer_h(3)[cowboy_tracer_h(3)]

1
doc/src/manual/cowboy_metrics_h.asciidoc
View file

@ -160,5 +160,6 @@ The metrics stream handler does not produce any event.
link:man:cowboy(7)[cowboy(7)],
link:man:cowboy_stream(3)[cowboy_stream(3)],
link:man:cowboy_compress_h(3)[cowboy_compress_h(3)],
link:man:cowboy_decompress_h(3)[cowboy_decompress_h(3)],
link:man:cowboy_stream_h(3)[cowboy_stream_h(3)],
link:man:cowboy_tracer_h(3)[cowboy_tracer_h(3)]

1
doc/src/manual/cowboy_stream_h.asciidoc
View file

@ -69,5 +69,6 @@ may not work properly if they are executed
link:man:cowboy(7)[cowboy(7)],
link:man:cowboy_stream(3)[cowboy_stream(3)],
link:man:cowboy_compress_h(3)[cowboy_compress_h(3)],
link:man:cowboy_decompress_h(3)[cowboy_decompress_h(3)],
link:man:cowboy_metrics_h(3)[cowboy_metrics_h(3)],
link:man:cowboy_tracer_h(3)[cowboy_tracer_h(3)]

1
doc/src/manual/cowboy_tracer_h.asciidoc
View file

@ -84,5 +84,6 @@ The tracer stream handler does not produce any event.
link:man:cowboy(7)[cowboy(7)],
link:man:cowboy_stream(3)[cowboy_stream(3)],
link:man:cowboy_compress_h(3)[cowboy_compress_h(3)],
link:man:cowboy_decompress_h(3)[cowboy_decompress_h(3)],
link:man:cowboy_metrics_h(3)[cowboy_metrics_h(3)],
link:man:cowboy_stream_h(3)[cowboy_stream_h(3)]