OFTPConnectionTimeout Property

A timeout for the class.

Object Oriented Interface

public function getOFTPConnectionTimeout($connectionid);
public function setOFTPConnectionTimeout($connectionid, $value);

Procedural Interface

ipworksedi_oftpserver_get($res, 25 , $connectionid);
ipworksedi_oftpserver_set($res, 25, $value , $connectionid);

Default Value

Remarks

A timeout for the class.

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

If OFTPConnectionTimeout 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.

The default value for OFTPConnectionTimeout is specified by the DefaultTimeout property.

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

This property is not available at design time.

Data Type

Integer