Timeout Property

The timeout value, in seconds, for the connection.

Syntax

ANSI (Cross Platform)
int GetTimeout(int iConnectionId);
int SetTimeout(int iConnectionId, int iTimeout); Unicode (Windows) INT GetTimeout(INT iConnectionId);
INT SetTimeout(INT iConnectionId, INT iTimeout);
- (int)timeout:(int)connectionId;
- (void)setTimeout:(int)connectionId:(int)newTimeout;
#define PID_MLLPSERVER_TIMEOUT 11

IPWORKSEDI_EXTERNAL void* IPWORKSEDI_CALL IPWorksEDI_MLLPServer_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);
IPWORKSEDI_EXTERNAL int IPWORKSEDI_CALL IPWorksEDI_MLLPServer_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal);
IPWORKSEDI_EXTERNAL int IPWORKSEDI_CALL IPWorksEDI_MLLPServer_CheckIndex(void *lpObj, int propid, int arridx);

Default Value

0

Remarks

The timeout value, in seconds, for the connection.

This property specifies the timeout, in seconds, to use for the connection.

If set to 0, all operations return immediately, potentially failing with a WOULDBLOCK error if data can't be sent immediately.

If 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 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 ConnectionCount property.

This property is not available at design time.

Data Type

Integer

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