Stream Idle Timeout Policy

Policy Name

Stream Idle Timeout

Summary

Sets the maximum duration a stream can remain idle without receiving a request or response

Category

Quality of Service

First Omni Gateway version available

v1.9.0

Returned Status Codes

504 - Stream timeout

Summary

The Stream Idle Timeout policy sets a maximum duration for which a stream can remain idle without receiving any data, either inbound from the client to Omni Gateway or outbound from Omni Gateway to the upstream service. The policy prevents idle connections from consuming resources unnecessarily. The timeout period starts at the last activity on the stream, whether the activity is a request or a response.

By default, all Omni Gateway API instances have a stream timeout of 300 seconds. Apply the policy to override the default timeout.

Configuring Policy Parameters

Omni Gateway Local Mode

When you apply the policy via declarative configuration files, Refer to the following policy definition and table of parameters:

- policyRef:
    name: stream-idle-timeout-flex
  config:
    timeout: number // REQUIRED

Parameter Required or Optional Default Value Description

Parameter	Required or Optional	Default Value	Description
`timeout`	Required	300	Time in seconds before Omni Gateway closes the connection.

timeout

Required

300

Time in seconds before Omni Gateway closes the connection.

Resource Configuration Example

- policyRef:
    name: stream-idle-timeout-flex
  config:
    timeout: 3

Managed Omni Gateway and Omni Gateway Connected Mode

When you apply the policy from the UI, the following parameters are displayed:

Element	Description	Required
Stream idle timeout	Time in seconds before Omni Gateway closes the connection.	Yes

Element

Description

Required

Stream idle timeout

Time in seconds before Omni Gateway closes the connection.

Yes