Timeout Property

A timeout for the component.

Object Oriented Interface

public function getTimeout();
public function setTimeout($value);

Procedural Interface

ipworksssh_sexec_get($res, 27 );
ipworksssh_sexec_set($res, 27, $value );

Default Value

Remarks

If the Timeout property is set to 0, all operations return immediately, potentially failing with an error if they can't be completed immediately.

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

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.

Optionally, the behavior of the class may be changed to absolute timeouts, i.e. the class will wait for a maximum of Timeout seconds since the beginning of the operation, without extending the timeout period during communications.

This behavior is controlled by the AbsoluteTimeout configuration setting.

The default value for the Timeout property is 60 seconds.

Data Type

Integer