IPWorks WebSockets 2020 Kotlin Edition

Questions / Feedback?

Timeout Property

A timeout for the component.

Syntax

public var timeout: Int

Default Value

60

Remarks

This property defines the timeout when sending data. When connceting to a plaintext URL (ws://) a value of 0 means data will be sent asynchronously and a positive value means data is sent synchronously. When connecting to a SSL URL (wss://) all data is sent synchronously regardless of the Timeout value. Please see the notes below for details.

Plaintext

If the Timeout property is set to 0, all operations return immediately, potentially failing with a WOULDBLOCK error if data cannot be sent immediately.

If Timeout is set to a positive value, data is sent in a blocking manner and the component will wait for the operation to complete before returning control. The component will handle any potential WOULDBLOCK errors internally and automatically retry the operation for a maximum of Timeout seconds.

SSL

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the component will wait for the operation to complete before returning control.

Additional Notes

The component 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 component throws an exception.

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 for the Timeout property is 60 seconds.

 
 
Copyright (c) 2021 /n software inc. - All rights reserved.
IPWorks WebSockets 2020 Kotlin Edition - Version 20.0 [Build 7721]