Timeout Property

A timeout for the class.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
int GetTimeout();
int SetTimeout(int iTimeout);

Unicode (Windows)
INT GetTimeout();
INT SetTimeout(INT iTimeout);

@property (nonatomic,readwrite,assign,getter=timeout,setter=setTimeout:) int timeout;
- (int)timeout;
- (void)setTimeout:(int)newTimeout;

#define PID_COAP_TIMEOUT 32

IPWORKSIOT_EXTERNAL void* IPWORKSIOT_CALL IPWorksIoT_CoAP_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);
IPWORKSIOT_EXTERNAL int IPWORKSIOT_CALL IPWorksIoT_CoAP_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal);

Default Value

60

Remarks

This property specifies the number of seconds that the class should wait, synchronously, for a response to be received. A value of 0 means that the class will send the request data (when operating in client mode) or the response data (when operating in server mode) asynchronously, and then wait indefinitely, firing the applicable event once complete.

The class will use DoEvents to enter an efficient wait loop during any potential waiting period, ensuring 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 response has not yet been received, the class throws an exception.

Data Type

Integer