Deprecate the inactivity_timeout options

When idle_timeout is configured we do not need a separate timer to detect inactivity. Disabling idle_timeout is not recommended and should not be necessary.
ninenines · Feb 7, 2025 · cc97c77 · cc97c77
1 parent dad67e1
commit cc97c77
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/doc/src/manual/cowboy_http.asciidoc b/doc/src/manual/cowboy_http.asciidoc
@@ -105,7 +105,7 @@ This option can be updated at any time using the
 
 inactivity_timeout (300000)::
 
-Time in ms with nothing received at all before Cowboy closes the connection.
+**DEPRECATED** Time in ms with nothing received at all before Cowboy closes the connection.
 
 initial_stream_flow_size (65535)::
 
@@ -183,6 +183,7 @@ Ordered list of stream handlers that will handle all stream events.
 
 == Changelog
 
+* *2.13*: The `inactivity_timeout` option was deprecated.
 * *2.13*: The `active_n` default value was changed to `1`.
 * *2.13*: The `dynamic_buffer` and `hibernate` options were added.
 * *2.11*: The `reset_idle_timeout_on_send` option was added.

diff --git a/doc/src/manual/cowboy_http2.asciidoc b/doc/src/manual/cowboy_http2.asciidoc
@@ -133,7 +133,7 @@ Time in ms with no data received before Cowboy closes the connection.
 
 inactivity_timeout (300000)::
 
-Time in ms with nothing received at all before Cowboy closes the connection.
+**DEPRECATED** Time in ms with nothing received at all before Cowboy closes the connection.
 
 initial_connection_window_size (65535)::
 
@@ -306,6 +306,7 @@ too many `WINDOW_UPDATE` frames.
 
 == Changelog
 
+* *2.13*: The `inactivity_timeout` option was deprecated.
 * *2.13*: The `active_n` default value was changed to `1`.
 * *2.13*: The `dynamic_buffer` and `hibernate` options were added.
 * *2.11*: Websocket over HTTP/2 is now considered stable.