abortTestWebsocketConnectivity()

abortTestWebsocketConnectivity()

Compatibility:
Prebuilt
Custom

The abortTestWebsocketConnectivity() method allows you to interrupt the ongoing websocket connectivity test initiated by testWebsocketConnectivity(). This can be useful if you want to stop the test before it completes and retrieve the results obtained up to the point of aborting. Calling abortTestWebsocketConnectivity() will interrupt the ongoing test and force an early return on the original testWebsocketConnectivity() call and a test-completed event will be sent. Those results will be partial, containing information about the regions where the websocket creation was attempted, whether it was aborted, and the regions that have passed or failed the connectivity test.

Refer to the documentation of testWebsocketConnectivity() for more details on the meaning of these properties and their possible values.

Example usage of abortTestWebsocketConnectivity():

Related methods and events