WebAppAPIClient

WebApp::APIClient###CloseTimeout

Defines timeout in milliseconds for the closing of a WebSocket connection in the frontend applications. Value of ‘0’ will disable the timeout.

This setting can not be deactivated.

Default value:

0

WebApp::APIClient###MaxReconnectionAttempts

Defines maximum number of attempts before giving up trying to re-establish a WebSocket connection in the frontend applications.

This setting can not be deactivated.

Default value:

10

WebApp::APIClient###MaxReconnectionDelay

Defines maximum delay in milliseconds when trying to re-establish a WebSocket connection in the frontend applications.

This setting can not be deactivated.

Default value:

10000

WebApp::APIClient###OpenTimeout

Defines timeout in milliseconds for the opening of a WebSocket connection in the frontend applications. Value of ‘0’ will disable the timeout.

This setting can not be deactivated.

Default value:

0

WebApp::APIClient###ReconnectionDelayIncrement

Defines increment delay in milliseconds with every reconnection attempt of a WebSocket connection in the frontend applications.

This setting can not be deactivated.

Default value:

1000

WebApp::APIClient###ResponseTimeout

Defines timeout in milliseconds for the responses of WebSocket requests in the frontend applications. Value of ‘0’ will disable the timeout. This value cannot be higher than ‘inactivity_timeout’ as configured in WebApp.conf.

This setting can not be deactivated.

Default value:

30000

WebApp::APIClient###WebSocketRequiresAuthentication

Defines if the WebSocket communication protocol is used for public users. It will only be considered if the “WebSocketUpgrade” is active.

This setting can not be deactivated.

Default value:

1

WebApp::APIClient###WebSocketUpgrade

Defines if the primary API client communication protocol should be upgraded to WebSocket, where possible.

This setting can not be deactivated.

Default value:

1
Scroll to Top