Skip to content

Commit

Permalink
docs: update doc comment for current OHKAMI_* environment variables (
Browse files Browse the repository at this point in the history
…#296)

* docs: update doc comment for current `OHKAMI_*` environment variables

* improve an expression
  • Loading branch information
kanarus authored Dec 1, 2024
1 parent 234ec08 commit 63949db
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 2 deletions.
5 changes: 3 additions & 2 deletions ohkami/src/ohkami/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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.
///
/// <br>
///
Expand Down
6 changes: 6 additions & 0 deletions ohkami/src/ws/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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.
///
/// <br>
///
/// *example.rs*
Expand Down

0 comments on commit 63949db

Please sign in to comment.