Add timeout detail comments

Author: jasongin

cs/src/Contracts/TunnelOptions.cs

@@ -99,8 +99,11 @@ public class TunnelOptions
         /// Gets or sets the timeout for HTTP requests to the tunnel or port.
         /// </summary>
         /// <remarks>
-        /// The default timeout is 100 seconds. If the host does not return a response before the timeout,
-        /// the tunnel relay aborts the request and returns 504 Gateway Timeout.
+        /// The default timeout is 100 seconds. Set this to 0 to disable the timeout. The timeout
+        /// will reset when response headers are received or after successfully reading or writing
+        /// any request, response, or streaming data like gRPC or WebSockets. TCP keep-alives and
+        /// HTTP/2 protocol pings will not reset the timeout, but WebSocket pings will. When a
+        /// request times out, the tunnel relay aborts the request and returns 504 Gateway Timeout.
         /// </remarks>
         [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
         public int? RequestTimeoutSeconds { get; set; }

go/tunnels/tunnel_options.go

@@ -61,7 +61,11 @@ type TunnelOptions struct {
 
 	// Gets or sets the timeout for HTTP requests to the tunnel or port.
 	//
-	// The default timeout is 100 seconds. If the host does not return a response before the
-	// timeout, the tunnel relay aborts the request and returns 504 Gateway Timeout.
+	// The default timeout is 100 seconds. Set this to 0 to disable the timeout. The timeout
+	// will reset when response headers are received or after successfully reading or writing
+	// any request, response, or streaming data like gRPC or WebSockets. TCP keep-alives and
+	// HTTP/2 protocol pings will not reset the timeout, but WebSocket pings will. When a
+	// request times out, the tunnel relay aborts the request and returns 504 Gateway
+	// Timeout.
 	RequestTimeoutSeconds                  int32 `json:"requestTimeoutSeconds,omitempty"`
 }

java/src/main/java/com/microsoft/tunnels/contracts/TunnelOptions.java

@@ -91,8 +91,12 @@ public class TunnelOptions {
     /**
      * Gets or sets the timeout for HTTP requests to the tunnel or port.
      *
-     * The default timeout is 100 seconds. If the host does not return a response before
-     * the timeout, the tunnel relay aborts the request and returns 504 Gateway Timeout.
+     * The default timeout is 100 seconds. Set this to 0 to disable the timeout. The
+     * timeout will reset when response headers are received or after successfully reading
+     * or writing any request, response, or streaming data like gRPC or WebSockets. TCP
+     * keep-alives and HTTP/2 protocol pings will not reset the timeout, but WebSocket
+     * pings will. When a request times out, the tunnel relay aborts the request and
+     * returns 504 Gateway Timeout.
      */
     @Expose
     public int requestTimeoutSeconds;

rs/src/contracts/tunnel_options.rs

@@ -72,8 +72,12 @@ pub struct TunnelOptions {
 
     // Gets or sets the timeout for HTTP requests to the tunnel or port.
     //
-    // The default timeout is 100 seconds. If the host does not return a response before
-    // the timeout, the tunnel relay aborts the request and returns 504 Gateway Timeout.
+    // The default timeout is 100 seconds. Set this to 0 to disable the timeout. The
+    // timeout will reset when response headers are received or after successfully reading
+    // or writing any request, response, or streaming data like gRPC or WebSockets. TCP
+    // keep-alives and HTTP/2 protocol pings will not reset the timeout, but WebSocket
+    // pings will. When a request times out, the tunnel relay aborts the request and
+    // returns 504 Gateway Timeout.
     #[serde(default)]
     pub request_timeout_seconds: Option<i32>,
 }

ts/src/contracts/tunnelOptions.ts

@@ -80,8 +80,12 @@ export interface TunnelOptions {
     /**
      * Gets or sets the timeout for HTTP requests to the tunnel or port.
      *
-     * The default timeout is 100 seconds. If the host does not return a response before
-     * the timeout, the tunnel relay aborts the request and returns 504 Gateway Timeout.
+     * The default timeout is 100 seconds. Set this to 0 to disable the timeout. The
+     * timeout will reset when response headers are received or after successfully reading
+     * or writing any request, response, or streaming data like gRPC or WebSockets. TCP
+     * keep-alives and HTTP/2 protocol pings will not reset the timeout, but WebSocket
+     * pings will. When a request times out, the tunnel relay aborts the request and
+     * returns 504 Gateway Timeout.
      */
     requestTimeoutSeconds?: number;
 }