get_timeout

Optislang.get_timeout() → float | None

Get the timeout value for executing commands.

Returns:

timeout: Union[float, None]

Timeout in seconds to perform commands. This value must be greater than zero or None. The default is None. Another function raises a timeout exception if the timeout value has elapsed before an operation has completed. If the timeout is None, functions wait until they’re finished, and no timeout exception is raised.

Raises:

OslCommunicationError

Raised when an error occurs while communicating with the server.

OslCommandError

Raised when a command or query fails.

TimeoutError

Raised when the timeout float value expires.