Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 9 additions & 0 deletions docs/src/main/paradox/common/timeouts.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,15 @@ on a connection for over `idle-timeout` time, the connection will be automatical
This setting should be used as a last-resort safeguard to prevent unused or stuck connections from consuming resources for
an indefinite time.

This is a bidirectional inactivity timeout. It triggers only when no
bytes are sent or received for the configured duration. Traffic in
either direction, including a client sending bytes at intervals shorter
than the timeout, keeps the connection alive; it is not an overall
request-receive timeout. Lowering this value and configuring
`pekko.http.server.parsing.max-content-length` reduce exposure but do not
bound request duration. Use an appropriately configured reverse proxy or
application-level entity timeout when a hard receive deadline is required.

The setting works the same way for server and client connections and it is configurable independently using the following keys:

```
Expand Down
9 changes: 9 additions & 0 deletions http-core/src/main/resources/reference.conf
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,15 @@ pekko.http {

# The time after which an idle connection will be automatically closed.
# Set to `infinite` to completely disable idle connection timeouts.
#
# Note: This is a bidirectional inactivity timeout. It triggers only when
# no bytes are sent or received for the configured duration. Traffic in
# either direction, including a client sending bytes at intervals shorter
# than the timeout, keeps the connection alive; it is not an overall
# request-receive timeout. Lowering this value and configuring
# pekko.http.server.parsing.max-content-length reduce exposure but do not
# bound request duration. Use an appropriately configured reverse proxy or
# application-level entity timeout when a hard receive deadline is required.
idle-timeout = 60 s

# Defines the default time period within which the application has to
Expand Down