Bandwidth and Traffic

The server offers information about the currently used bandwidth by the server as well as for file transfers.

The available variables to be queried are specified in the ConnectionProperties and ConnectionPropertiesSDK enums.

However only the following values can be queried server side: CONNECTION_PACKETS_SENT_TOTAL CONNECTION_BYTES_SENT_TOTAL CONNECTION_PACKETS_RECEIVED_TOTAL CONNECTION_BYTES_RECEIVED_TOTAL CONNECTION_BANDWIDTH_SENT_LAST_SECOND_TOTAL CONNECTION_BANDWIDTH_SENT_LAST_MINUTE_TOTAL CONNECTION_BANDWIDTH_RECEIVED_LAST_SECOND_TOTAL CONNECTION_BANDWIDTH_RECEIVED_LAST_MINUTE_TOTAL

Query values

To query these values use the following functions based on the type of information you want to receive:

unsigned int ts3server_getVirtualServerConnectionVariableAsDouble(uint64 serverID, enum ConnectionProperties flag, double *result)

get value of server connection properties as double

Parameters:

  • serverID – which server to get connection properties of

  • flag – specifies which value to get. One of the values from the ConnectionProperties enum

  • result – address of a variable to receive the value of the connection property.

Returns:

An Error code from the Ts3ErrorType enum indicating either success or the failure reason

unsigned int ts3server_getVirtualServerConnectionVariableAsUInt64(uint64 serverID, enum ConnectionProperties flag, uint64 *result)

get value of server connection properties as unsigned integer.

Parameters:

  • serverID – which server to get connection properties of

  • flag – specifies which property to get the value of. One of the values from the ConnectionProperties enum

  • result – address of a variable to receive the value of the connection property

Returns:

An Error code from the Ts3ErrorType enum indicating either success or the failure reason