azure_relay_proxy_connection_timeout Property

This property specifies a timeout for the class.

Syntax

def get_azure_relay_proxy_connection_timeout(connection_id: int) -> int: ...
def set_azure_relay_proxy_connection_timeout(connection_id: int, value: int) -> None: ...

Default Value

0

Remarks

This property specifies a timeout for the class.

If the azure_relay_proxy_connection_timeout property is set to 0, all operations return immediately, potentially failing with a WOULDBLOCK error if data cannot be sent immediately.

If azure_relay_proxy_connection_timeout is set to a positive value, data is sent in a blocking manner and the class will wait for the operation to complete before returning control. The class will handle any potential WOULDBLOCK errors internally and automatically retry the operation for a maximum of azure_relay_proxy_connection_timeout seconds.

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 the azure_relay_proxy_connection_timeout property is 0 (asynchronous operation).

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