Skip to content
CA API Gateway - 9.3
Documentation powered by DocOps

WebSocket Cluster Properties

Last update November 21, 2017

The following cluster properties configure WebSocket behavior on the Gateway node or node cluster. For more information, see Manage WebSocket Connections.

Property

Description

websocket.accept.queue.size

The maximum requests that can be buffered. Requires a Gateway restart.

Default: 100

websocket.client.buffer.size

The outbound client buffer size. Requires a Gateway restart. 

Default: 4096 (bytes)

websocket.inbound.connection.idle

The idle time for all inbound connections. Requires a Gateway restart. 

Default: 60000 (milliseconds)

websocket.max.binary.msg.size

The maximum text binary size. Requires a Gateway restart. 

Default: 1048576 (bytes)

websocket.max.inbound.connections

The maximum number of connections for a single connection definition. The connection definition can set a lower value if desired. Requires a Gateway restart. 

Default: 4096

websocket.max.inbound.threads

The maximum number of threads available for inbound connections. Requires a Gateway restart. 

Default: 25

websocket.max.outbound.threads

The maximum number of threads available for outbound connections. Requires a Gateway restart. 

Default: 25

websocket.max.text.msg.size

The maximum text message size. Requires a Gateway restart. 

Default: 1048576 (bytes)

websocket.min.inbound.threads

The minimum number of threads available for inbound connections. Requires a Gateway restart. 

Default: 10

websocket.min.outbound.threads

The minimum number of threads available for outbound connections. Requires a Gateway restart. 

Default: 10

websocket.outbound.client.connection.timeout

The amount of time an outbound connection will wait before timeout occurs. Requires a Gateway restart. 

Default: 20 (seconds)

websocket.outbound.connection.idle

The idle time for all outbound client connections. Requires a Gateway restart. 

Default: 60000 (milliseconds)

websocket.outbound.only.connection.reconnect.interval

The retry interval for reconnecting outbound-only connections to the WebSocket server. Requires a Gateway restart.

Default: 300000 (milliseconds). 

websocket.inbound.copy.upgrade.request.subprotocol.header

This property copies the upgrade request header "Sec-Websocket-Protocol" values to the response header of the same name. Set this property to false if you need to modify this header within a connection policy. Requires a Gateway restart.

Default: true


Was this helpful?

Please log in to post comments.