Skip to content

Commit 9cc9329

Browse files
committed
Improve aleph.http/start-server's docstring for :idle-timeout
Explain what exactly idle means and remove needlessly narrow and potentially misleading reference to keep-alive connections. Closes #609.
1 parent c56516e commit 9cc9329

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

src/aleph/http.clj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@
4949
| `epoll?` | if `true`, uses `epoll` when available, defaults to `false`
5050
| `compression?` | when `true` enables http compression, defaults to `false`
5151
| `compression-level` | optional compression level, `1` yields the fastest compression and `9` yields the best compression, defaults to `6`. When set, enables http content compression regardless of the `compression?` flag value
52-
| `idle-timeout` | when set, forces keep-alive connections to be closed after an idle time, in milliseconds
52+
| `idle-timeout` | when set, connections are closed after not having performed any I/O operations for the given duration, in milliseconds. Defaults to `0` (infinite idle time).
5353
| `continue-handler` | optional handler which is invoked when header sends \"Except: 100-continue\" header to test whether the request should be accepted or rejected. Handler should return `true`, `false`, ring responseo to be used as a reject response or deferred that yields one of those.
5454
| `continue-executor` | optional `java.util.concurrent.Executor` which is used to handle requests passed to :continue-handler. To avoid this indirection you may specify `:none`, but in this case extreme care must be taken to avoid blocking operations on the handler's thread."
5555
[handler options]

0 commit comments

Comments
 (0)