wodSFTP API library - Timeout Property
      
 

Description

Timeout value, in seconds.


Return type

A Long value. If successful, 0 is returned, otherwise error as specified here.


Syntax

long Sftp_GetTimeout(void *Sftp, short *Timeout);
long Sftp_SetTimeout(void *Sftp, short Timeout);

The Timeout function syntax has these parts:

Part Description
void *Sftp Handle of the created Sftp instance.
short *Timeout An short value. Determines number of seconds before user will be disconnected.

Remarks

The Timeout value specifies how many seconds must pass without any activity between wodSFTP and remote server before wodSFTP will automatically disconnect from it. Automatic disconnection is a measure of protection against 'ghost' connections made between you and the remote server. If you don't want autodisconnection to occur, set Timeout to 0.

Timeout can be changed during the lifetime of a connection. You shouldn't set it below 120 (2 minutes) if you're on slow network connection.