WebSocket

server/websocket

Specifies the configuration for WebSocket support.

Properties

NameTypeConstraintsDescription
worker_threadsworker_threads
timeoutstimeouts

server/websocket/worker_threads

The number of available WebSocket worker threads.

Properties

NameTypeConstraintsDescription
maxnumberMinimum: 0

Maximum: unlimited

Default value: 0
The maximum number of threads which will be used used to proxy WebSocket connections through the gateway. A value of zero will cause WebSockets to be blocked. Each WebSocket connection will require two worker threads. If more than the max value are in use, the daemon will immediately close the WebSocket even if the WebSocket upgrade request to the application succeeded. The WebSocket threads operate independently from the server:worker_threads entry.
idlenumberMinimum: 0

Maximum: unlimited

Default value: 0
To avoid the overhead of starting and stopping web socket worker threads a number of threads can be left running idle. This will consume memory resources to keep them alive and idle when not in use, but will save CPU and thread start-up time when a new web socket requires threads. This option specifies the maximum count of cached idle worker threads. A value of zero will disable the caching of idle threads.

server/websocket/timeouts

Web socket timeout settings.

Properties

NameTypeConstraintsDescription
applicationsapplications
front_endfront_end

server/websocket/timeouts/applications

Specifies the web socket timeouts for connections between the gateway daemon and protected applications (in seconds). If the timeout is reached the web socket connection will be closed.

Properties

NameTypeConstraintsDescription
readnumberMinimum: 1

Maximum: unlimited

Default value: 120
The maximum length of time (in seconds) to wait on a read operation to complete.
writenumberMinimum: 1

Maximum: unlimited

Default value: 20
The maximum length of time (in seconds) to wait on a write operation to complete.

server/websocket/timeouts/front_end

Specifies the web socket timeouts for connections to the gateway (in seconds). If the timeout is reached the web socket connection will be closed.

Properties

NameTypeConstraintsDescription
readnumberMinimum: 1

Maximum: unlimited

Default value: 120
The maximum length of time (in seconds) to wait on a read operation to complete.
writenumberMinimum: 1

Maximum: unlimited

Default value: 20
The maximum length of time (in seconds) to wait on a write operation to complete.

Example

server:
  websocket:
    worker_threads:
      max: 100
      idle: 0
    timeouts:
      applications:
        read: 30
        write: 30
      front_end:
        read: 30
        write: 30

Did this page help you?