set_timeout#

Optislang.set_timeout(timeout: float | None = None) None#

Set the timeout value for the executing commands.

Parameters:
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.

ValueError

Raised when the timeout value is less than or equal to 0.

TypeError

Raised when the timeout is not a Union[float, None].