oftp_connection_timeout Property

A timeout for the class.

Syntax

def get_oftp_connection_timeout(connection_id: int) -> int: ...
def set_oftp_connection_timeout(connection_id: int, value: int) -> None: ...

Default Value

0

Remarks

A timeout for the class.

If the oftp_connection_timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If oftp_connection_timeout is set to a positive value, the class will wait for the operation to complete before returning control.

The class will use on_do_events to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If timeout expires, and the operation is not yet complete, the class fails with an error.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by timeout seconds when any amount of data is successfully sent or received.

The default value for oftp_connection_timeout is specified by the default_timeout property.

The connection_id parameter specifies the index of the item in the array. The size of the array is controlled by the oftp_connection_count property.