« Back to Product

Documentation

Send feedback!

IPS_GetActiveWebSocketConnections

 int IPS_GetActiveWebSocketConnections ()

Returns

Number of currently open WebSocket connections

Description

Warning

This function is intended for internal use only and may change or be removed at any time without notice.

The function returns the number of currently open WebSocket connections (unencrypted and encrypted) across all servers operated by the web server of Symcon – the default port 3777 as well as the ports of the WebServer instances. Visualizations and the console, for example, are connected via WebSocket to receive messages.

The regular HTTP connections are returned by IPS_GetActiveWebServerConnections. Details about the individual connections and their send queues are returned by IPS_GetConnectionList.

Example

echo "Open WebSocket connections: " . IPS_GetActiveWebSocketConnections();

/* e.g. returns:
Open WebSocket connections: 3
*/
Any questions?