Minor documenation updates

hummingbird-project · Nov 15, 2024 · 6d796fd · 6d796fd
1 parent 9154802
commit 6d796fd
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/Sources/HummingbirdCore/Server/HTTP/HTTP1Channel.swift b/Sources/HummingbirdCore/Server/HTTP/HTTP1Channel.swift
@@ -26,7 +26,7 @@ public struct HTTP1Channel: ServerChildChannel, HTTPChannelHandler {
     public struct Configuration: Sendable {
         /// Additional channel handlers to add to channel pipeline after HTTP part decoding and before HTTP request handling
         public var additionalChannelHandlers: @Sendable () -> [any RemovableChannelHandler]
-        /// Time before closing an idle channel
+        /// Time before closing an idle channel.
         public var idleTimeout: TimeAmount?
 
         ///  Initialize HTTP1Channel.Configuration

diff --git a/Sources/HummingbirdHTTP2/HTTP2Channel.swift b/Sources/HummingbirdHTTP2/HTTP2Channel.swift
@@ -47,8 +47,9 @@ public struct HTTP2UpgradeChannel: HTTPChannelHandler {
 
         ///  Initialize HTTP2UpgradeChannel.Configuration
         /// - Parameters:
-        ///   - idleTimeout: How long connection is kept idle before closing
+        ///   - idleTimeout: How long connection is kept idle before closing. A connection is considered idle when it has no open streams
         ///   - maxGraceCloseTimeout: Maximum amount of time to wait for client response before all streams are closed after second GOAWAY
+        ///   - maxAgeTimeout: Maximum amount of time for a connection to be open.
         ///   - streamConfiguration: Configuration applieds to HTTP2 stream channels
         public init(
             idleTimeout: Duration? = nil,