ClientIdleTimeout Property

The idle timeout for this connection.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
int GetClientIdleTimeout(int iClientId);
int SetClientIdleTimeout(int iClientId, int iClientIdleTimeout);

Unicode (Windows)
INT GetClientIdleTimeout(INT iClientId);
INT SetClientIdleTimeout(INT iClientId, INT iClientIdleTimeout);

- (int)clientIdleTimeout:(int)clientId;
- (void)setClientIdleTimeout:(int)clientId:(int)newClientIdleTimeout;

#define PID_SSHTUNNEL_CLIENTIDLETIMEOUT 10

IPWORKSSSH_EXTERNAL void* IPWORKSSSH_CALL IPWorksSSH_SSHTunnel_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);
IPWORKSSSH_EXTERNAL int IPWORKSSSH_CALL IPWorksSSH_SSHTunnel_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal);
IPWORKSSSH_EXTERNAL int IPWORKSSSH_CALL IPWorksSSH_SSHTunnel_CheckIndex(void *lpObj, int propid, int arridx);

Default Value

0

Remarks

The idle timeout for this connection. This property is similar to DefaultIdleTimeout but may be set on a per-connection basis to override DefaultIdleTimeout. This property specifies the idle timeout (in seconds) for the connected client. When set to a positive value the class will disconnect idle clients after the specified timeout.

This only applies to clients that have not send to received data within the specified number of seconds.

If set to 0 (default) no idle timeout is applied.

Note: DoEvents must be called in order for the class to check existing connections.

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