From 63949db4773cc5a03e512e3576fa63d51c854216 Mon Sep 17 00:00:00 2001 From: kanarus Date: Sun, 1 Dec 2024 23:00:13 +0900 Subject: [PATCH] docs: update doc comment for current `OHKAMI_*` environment variables (#296) * docs: update doc comment for current `OHKAMI_*` environment variables * improve an expression --- ohkami/src/ohkami/mod.rs | 5 +++-- ohkami/src/ws/mod.rs | 6 ++++++ 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/ohkami/src/ohkami/mod.rs b/ohkami/src/ohkami/mod.rs index 2ea2a97a..8105c6b7 100644 --- a/ohkami/src/ohkami/mod.rs +++ b/ohkami/src/ohkami/mod.rs @@ -251,8 +251,9 @@ impl Ohkami { /// - `smol::net::AsyncToSocketAddrs` if using `smol` /// - `std::net::ToSocketAddrs` if using `nio` or `glommio` /// - /// *note* : Keep-Alive timeout is 42 seconds and this is not - /// configureable by user (it'll be in future version...) + /// *note* : Keep-Alive timeout is 42 seconds by default. + /// This is configureable by `OHKAMI_KEEPALIVE_TIMEOUT` + /// environment variable. /// ///
/// diff --git a/ohkami/src/ws/mod.rs b/ohkami/src/ws/mod.rs index 462aab9b..87d4eec9 100644 --- a/ohkami/src/ws/mod.rs +++ b/ohkami/src/ws/mod.rs @@ -10,6 +10,12 @@ pub use self::worker::*; /// # Context for WebSocket handshake /// +/// `.upgrade` performs handshake and creates a WebSocket session. +/// +/// *note* : The session is timeout in 3600 seconds ( = 1 hour ) +/// by default. This is configurable by `OHKAMI_WEBSOCKET_TIMEOUT` +/// environment variable. +/// ///
/// /// *example.rs*