AzureRelayConnectionTimeout Property

This property specifies a timeout for the class.

Object Oriented Interface

public function getAzureRelayConnectionTimeout($connectionid);
public function setAzureRelayConnectionTimeout($connectionid, $value);

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 20 , $connectionid);
ipworksmq_azurerelayreceiver_set($res, 20, $value , $connectionid);

Default Value

0

Remarks

This property specifies a timeout for the class.

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

If AzureRelayConnectionTimeout 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 AzureRelayConnectionTimeout seconds.

The class will use DoEvents 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 AzureRelayConnectionTimeout property is 0(asynchronous operation).

The $connectionid parameter specifies the index of the item in the array. The size of the array is controlled by the AzureRelayConnectionCount property.

This property is not available at design time.

Data Type

Integer

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks MQ 2020 PHP Edition - Version 20.0 [Build 8155]