system.vision.getConnectTimeout

Backwards Compatibility

This function replaces system.util.getConnectTimeout. Any scripts containing Vision Client scoped functions that were replaced with system.vision syntax will still work to maintain backwards compatibility. Only the system.vision variations will appear in the Script Editor's autocomplete popup.

This function is used in Python Scripting.

Description

Returns the connect timeout in milliseconds for all Client-to-Gateway communication. This is the maximum amount of time that communication operations to the Gateway will be given to connect. The default is 10,000ms (10 seconds).

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

system.vision.getConnectTimeout()

Parameters

Nothing

Returns

Integer - The current connect timeout, in milliseconds. Default is 10,000 (ten seconds)

Scope

Vision Client

Code Examples

Example #1

# This code would print out the current connect timeout
print system.vision.getConnectTimeout()