Set/Get Sync Timeout

Set or retrieve the number of seconds that API calls in Sync Mode will wait for a response from the IB app before giving up. The default value is set to 5 seconds.

sync_timeout(timeout)

Arguments

timeout	Numeric, length 1, specifying the time in seconds that API calls made in Sync Mode will wait for a response from IB before giving up. The default value is 5 seconds. sync_timeout() is called with argument timeout is not specified in the call, then sync_timeout() will return the current timeout setting (in seconds) as a numeric.

See also

Other utilities: active_connection_parameters(), clean_slate(), create_new_connections(), disconnect(), read_sock_drawer(), socks(), start_api()

Examples

# Fetch the current timeout setting for SYNC functions (in seconds):
sync_timeout()
#> [1] 5

# Set the time out setting for SYNC functions to 10 seconds:
sync_timeout(10)
#> ✔ sync timeoutset to: 10 secs.

# Fetch the new setting:
sync_timeout()
#> [1] 10