Legacy Documentation: Version 5.6 (Go to current version)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

NetworkTransport.GetOutgoingPacketOverflowLossPercent

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

public static function GetOutgoingPacketOverflowLossPercent(hostId: int, connectionId: int, out error: byte): int;
public static int GetOutgoingPacketOverflowLossPercent(int hostId, int connectionId, out byte error);

Parameters

hostId Host ID associated with this connection.
connectionId ID of the connection.
error Error (can be cast to NetworkError for more information).

Returns

int The number of packets dropped by the peer in the last ping timeout period expressed as an integer percentage from 0 to 100.

Description

Returns the value in percent of the number of sent packets that were dropped by the peer.

This value is calculated from packets dropped by the peer between subsequent “keep alive” or ping packets. The packet rate is set, so the number of packets lost can be calculated from the expected number of incoming packets and the actual number of incoming packets. Peers can drop packets when they receive too many in a short time, or are unable to process the packets they have received due to lack of resources.