IdleTimeout Property

The idle timeout for this connection.

Syntax

ANSI (Cross Platform)
int GetIdleTimeout(int iConnectionId);
int SetIdleTimeout(int iConnectionId, int iIdleTimeout);

Unicode (Windows)
INT GetIdleTimeout(INT iConnectionId);
INT SetIdleTimeout(INT iConnectionId, INT iIdleTimeout);
- (int)idleTimeout:(int)connectionId;
- (void)setIdleTimeout:(int)connectionId:(int)newIdleTimeout;

#define PID_IPDAEMON_IDLETIMEOUT 9

IPWORKS_EXTERNAL void* IPWORKS_CALL IPWorks_IPDaemon_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);
IPWORKS_EXTERNAL int IPWORKS_CALL IPWorks_IPDaemon_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal);
IPWORKS_EXTERNAL int IPWORKS_CALL IPWorks_IPDaemon_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 ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the ConnectionCount property.

This property is not available at design time.

Data Type

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