Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(docs): add info on required timer for header_read_timeout #3585

Merged
merged 2 commits into from
Feb 29, 2024
Merged

chore(docs): add info on required timer for header_read_timeout #3585

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7fce922
chore(docs): add info on required timer for header_read_timeout
dswij Feb 28, 2024
47ca6ea
chore(docs): remove `header_read_timeout` from `http1::Builder` example
dswij Feb 28, 2024
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
5 changes: 4 additions & 1 deletion src/server/conn/http1.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ pin_project_lite::pin_project! {
/// # fn main() {
/// let mut http = Builder::new();
/// // Set options one at a time
/// http.header_read_timeout(Duration::from_millis(200));
/// http.half_close(false);
///
/// // Or, chain multiple options
/// http.keep_alive(false).title_case_headers(true).max_buf_size(8192);
Expand Down Expand Up @@ -316,6 +316,9 @@ impl Builder {
/// Set a timeout for reading client request headers. If a client does not
/// transmit the entire header within this time, the connection is closed.
///
/// Requires a [`Timer`] set by [`Builder::timer`] to take effect. Panics if `header_read_timeout` is configured
/// without a [`Timer`].
///
/// Pass `None` to disable.
///
/// Default is 30 seconds.
Expand Down
Loading