Skip to main content

Web Socket

Description

Specifies the configuration for Web socket support.

Properties

The following table(s) describe the configuration properties for this component:

Name Type Constraints Description
timeouts TIMEOUTS Object
max number Minimum:0
Maximum:unlimited
Default:0
The maximum number of threads which will be used used to proxy web socket connections through the gateway. A value of zero will cause web sockets to be blocked. Each web socket connection will require two worker threads. If more than the max value are in use, the daemon will immediately close the web socket even if the web socket upgrade request to the application succeeded. The web socket threads operate independently from the server:worker_threads entry.
idle number Minimum:0
Maximum:unlimited
Default: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.
worker_threads number Minimum:1
Maximum:unlimited
The number of available Web socket worker threads.

TIMEOUTS Object

Web socket timeout settings.

Name Type Constraints Description
applications APPLICATIONS Object
front_end FRONT_END Object

APPLICATIONS Object

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.

Name Type Constraints Description
read number Minimum:1
Maximum:unlimited
Default:120
The maximum length of time (in seconds) to wait on a read operation to complete.
write number Minimum:1
Maximum:unlimited
Default:120
The maximum length of time (in seconds) to wait on a write operation to complete.

FRONT_END Object

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

Name Type Constraints Description
read number Minimum:1
Maximum:unlimited
Default:120
The maximum length of time (in seconds) to wait on a read operation to complete.
write number Minimum:1
Maximum:unlimited
Default:120
The maximum length of time (in seconds) to wait on a write operation to complete.

Example

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