IPWorks SSH 2020 C++ Builder Edition

Questions / Feedback?

ClientTimeout Property

This property specifies a timeout for the component.

Syntax

__property int ClientTimeout[int ClientId] = { read=FClientTimeout, write=FSetClientTimeout };

Default Value

0

Remarks

This property specifies a timeout for the component.

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

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

The component 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 component raises an exception.

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

The ClientId parameter specifies the index of the item in the array. The size of the array is controlled by the ClientCount property.

This property is not available at design time.

Data Type

Integer

Copyright (c) 2023 /n software inc. - All rights reserved.
IPWorks SSH 2020 C++ Builder Edition - Version 20.0 [Build 8501]