GetNetworkStats - Revision history

Jaysds at 02:10, 11 April 2012

2012-04-11T02:10:09Z

← Older revision		Revision as of 02:10, 11 April 2012
Line 1:		Line 1:
	~~{{Needs Checking\|Example #3 is untested}}~~
	__NOTOC__		__NOTOC__
	{{Server client function}}		{{Server client function}}
Line 56:		Line 55:
	setTimer(packetLossCheck, 1000, 0)		setTimer(packetLossCheck, 1000, 0)
	</syntaxhighlight>		</syntaxhighlight>
	This example tracks the average and peak packetloss over the last 60 seconds		This example tracks the average and peak packetloss over the last 60 seconds '''PLEASE NOTE:''' this example is untested.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	PACKETLOSS_HISTORY_LENGTH = 60 -- Sample period in seconds		PACKETLOSS_HISTORY_LENGTH = 60 -- Sample period in seconds

2012-03-08T20:46:11Z

← Older revision		Revision as of 20:46, 8 March 2012
Line 1:		Line 1:
			{{Needs Checking\|Example #3 is untested}}
	__NOTOC__		__NOTOC__
	{{Server client function}}		{{Server client function}}

2012-03-08T20:42:37Z

@@ Line 54: / Line 54: @@
 end
 setTimer(packetLossCheck, 1000, 0)
 </syntaxhighlight>
 </section>

2012-02-28T22:45:58Z

← Older revision		Revision as of 22:45, 28 February 2012
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==

2011-08-12T14:14:06Z

Client examples

← Older revision		Revision as of 14:14, 12 August 2011
Line 23:		Line 23:

	===Returns===		===Returns===
	Returns a table ~~of network information~~:		Returns a table, the indexes in the table are the following:

	* "bytesReceived"		* "bytesReceived"
Line 38:		Line 38:

	==Example==		==Example==
	~~TODO.~~		<section name="Client" class="client" show="true">
			This example outputs the local players network status information to their console when using the /netstatus command
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~-- This example does boo booo~~		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)
	</syntaxhighlight>		</syntaxhighlight>
			This example outputs a warning to local player if packet loss occured in the last second
			<syntaxhighlight lang="lua">
			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)
			</syntaxhighlight>
			</section>

	==See Also==		==See Also==
	{{Client_utility_functions}}		{{Client_utility_functions}}

2011-08-12T09:43:48Z

← Older revision		Revision as of 09:43, 12 August 2011
Line 15:		Line 15:
	<section name="Server" class="server" show="true">		<section name="Server" class="server" show="true">
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	table getNetworkStats ( element thePlayer )		table getNetworkStats ( [ element thePlayer = nil ] )
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>

			===Optional Arguments===
			*'''thePlayer:''' The player you want to retrieve network stats from.

	===Returns===		===Returns===
Line 34:		Line 37:
	* "encryptionStatus"		* "encryptionStatus"

	~~'''Note: this page is unfinished (not sure on the actual table structure)'''~~		==Example==
			TODO.
			<syntaxhighlight lang="lua">
			-- This example does boo booo
			</syntaxhighlight>

	==See Also==		==See Also==
	{{Client_utility_functions}}		{{Client_utility_functions}}

2011-08-10T10:40:13Z

← Older revision		Revision as of 10:40, 10 August 2011
Line 10:		Line 10:
	<section name="Client" class="client" show="true">		<section name="Client" class="client" show="true">
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	table getNetworkStats()		table getNetworkStats ( )
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>
	<section name="Server" class="server" show="true">		<section name="Server" class="server" show="true">
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	table getNetworkStats(element ~~Player~~)		table getNetworkStats ( element thePlayer )
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>