The server offers information about the currently used bandwidth.
The following set of connection properties can be queried:
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
In addition to the common connection properties, if filetransfer is enabled, the following filetransfer extra connection properties are available.
CONNECTION_FILETRANSFER_BANDWIDTH_SENT
How many bytes per second are currently being sent by file transfers
CONNECTION_FILETRANSFER_BANDWIDTH_RECEIVED
How many bytes per second are currently being received by file transfers
CONNECTION_FILETRANSFER_BYTES_RECEIVED_TOTAL
How many bytes we received in total through file transfers
CONNECTION_FILETRANSFER_BYTES_SENT_TOTAL
How many bytes we sent in total through file transfers
The connection information can be queried with the following two functions:
unsigned int ts3server_getVirtualServerConnectionVariableAsUInt64( | serverID, | |
flag, | ||
result) ; |
uint64 serverID
;enum ConnectionProperties flag
;uint64* result
;
unsigned int ts3server_getVirtualServerConnectionVariableAsDouble( | serverID, | |
flag, | ||
result) ; |
uint64 serverID
;enum ConnectionProperties flag
;double* result
;serverID
Server ID
flag
One of the above listed connection properties.
result
Address of a variable that receives the result value as uint64 (unsigned 64-bit integer) or double type, depending on which of the two functions was used.
Both functions return ERROR_ok
on success, otherwise an error code as defined in public_errors.h
.