GetNetworkStats: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Client examples)
No edit summary
Line 2: Line 2:
{{Server client function}}
{{Server client function}}
This function returns network status information.
This function returns network status information.
{{New feature|3.0110|1.1|
Available in 1.1 and onwards
}}


==Syntax==
==Syntax==
Line 25: Line 21:
Returns a table, the indexes in the table are the following:
Returns a table, the indexes in the table are the following:


* "bytesReceived"
* '''bytesReceived''' - Total number of bytes received since the connection was started
* "bytesSent"
* '''bytesSent''' - Total number of bytes sent since the connection was started
* "packetsReceived"
* '''packetsReceived''' - Total number of packets received since the connection was started
* "packetsSent"
* '''packetsSent''' - Total number of packets sent since the connection was started
* "packetlossTotal"
* '''packetlossTotal''' - (0-100) Total packet loss percentage of sent data, since the connection was started
* "packetlossLastSecond"
* '''packetlossLastSecond''' - (0-100) Packet loss percentage of sent data, during the previous second
* "messagesInSendBuffer"
* '''messagesInSendBuffer'''
* "messagesInResendBuffer"
* '''messagesInResendBuffer''' - Number of packets queued to be resent (due to packet loss)
* "isLimitedByCongestionControl"
* '''isLimitedByCongestionControl'''
* "isLimitedByOutgoingBandwidthLimit"
* '''isLimitedByOutgoingBandwidthLimit'''
* "encryptionStatus"
* '''encryptionStatus'''


==Example==
==Example==

Revision as of 22:45, 28 February 2012

This function returns network status information.

Syntax

Click to collapse [-]
Client
table getNetworkStats ( )
Click to collapse [-]
Server
table getNetworkStats ( [ element thePlayer = nil ] )

Optional Arguments

  • thePlayer: The player you want to retrieve network stats from.

Returns

Returns a table, the indexes in the table are the following:

  • bytesReceived - Total number of bytes received since the connection was started
  • bytesSent - Total number of bytes sent since the connection was started
  • packetsReceived - Total number of packets received since the connection was started
  • packetsSent - Total number of packets sent since the connection was started
  • packetlossTotal - (0-100) Total packet loss percentage of sent data, since the connection was started
  • packetlossLastSecond - (0-100) Packet loss percentage of sent data, during the previous second
  • messagesInSendBuffer
  • messagesInResendBuffer - Number of packets queued to be resent (due to packet loss)
  • isLimitedByCongestionControl
  • isLimitedByOutgoingBandwidthLimit
  • encryptionStatus

Example

Click to collapse [-]
Client

This example outputs the local players network status information to their console when using the /netstatus command 

function netStatus()
	for index, value in pairs(getNetworkStats()) do
		outputConsole(index..": "..value)
	end
	outputChatBox("Network status output to console", 0, 255, 0)
end
addCommandHandler("netstatus", netStatus)

This example outputs a warning to local player if packet loss occured in the last second 

function packetLossCheck()
	local loss = getNetworkStats()["packetlossLastSecond"]
	if (loss > 0) then
		outputChatBox("Packet loss detected when communicating with server, gameplay may be affected", 255, 0, 0)
	end
end
setTimer(packetLossCheck, 1000, 0)

See Also



Retrieved from "https://wiki.multitheftauto.com/wiki/GetNetworkStats?oldid=29524"