Skip to content

Commit b2fb939

Browse files
committed
docs: correct Adapter::new rustdoc for configurable idle timeout and SnapStart pooling
1 parent 0a3a232 commit b2fb939

1 file changed

Lines changed: 6 additions & 1 deletion

File tree

src/lib.rs

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -884,7 +884,12 @@ impl Adapter<HttpConnector, Body> {
884884
/// Creates a new HTTP Adapter instance.
885885
///
886886
/// This function initializes a new HTTP client configured to communicate with
887-
/// your web application, using a 4-second idle timeout for connection pooling.
887+
/// your web application. The idle-connection keep-alive comes from
888+
/// [`AdapterOptions::pool_idle_timeout`] (`AWS_LWA_POOL_IDLE_TIMEOUT_SECONDS`,
889+
/// default 4 seconds). Under SnapStart
890+
/// (`AWS_LAMBDA_INITIALIZATION_TYPE=snap-start`) the client additionally sets
891+
/// `pool_max_idle_per_host(0)`, so no idle connection can be captured in the
892+
/// snapshot and handed out dead after a restore.
888893
///
889894
/// # Arguments
890895
///

0 commit comments

Comments
 (0)