SFTPConnectionTimeout Property

A timeout for the class.

Syntax

ANSI (Cross Platform)
int GetSFTPConnectionTimeout(int iConnectionId);
int SetSFTPConnectionTimeout(int iConnectionId, int iSFTPConnectionTimeout); Unicode (Windows) INT GetSFTPConnectionTimeout(INT iConnectionId);
INT SetSFTPConnectionTimeout(INT iConnectionId, INT iSFTPConnectionTimeout);
- (int)SFTPConnectionTimeout:(int)connectionId;
- (void)setSFTPConnectionTimeout:(int)connectionId:(int)newSFTPConnectionTimeout;
#define PID_SFTPSERVER_SFTPCONNECTIONTIMEOUT 10

IPWORKSSFTP_EXTERNAL void* IPWORKSSFTP_CALL IPWorksSFTP_SFTPServer_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);
IPWORKSSFTP_EXTERNAL int IPWORKSSFTP_CALL IPWorksSFTP_SFTPServer_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal);
IPWORKSSFTP_EXTERNAL int IPWORKSSFTP_CALL IPWorksSFTP_SFTPServer_CheckIndex(void *lpObj, int propid, int arridx);

Default Value

0

Remarks

A timeout for the class.

If the Timeout property is set to 0, all operations return immediately, potentially failing with an 'WOULDBLOCK' error if data can't be sent or received immediately.

If Timeout is set to a positive value, the class will automatically retry each operation that would otherwise result in a 'WOULDBLOCK' error for a maximum of Timeout 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 Timeout 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 SFTPConnectionCount property.

This property is not available at design time.

Data Type

Integer

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks SFTP 2020 C++ Edition - Version 20.0 [Build 8162]