NetworkMonitor Class Reference

NetworkMonitor is responsible for actively monitoring network quality metrics such as latency, jitter, packet loss, bandwidth, and throughput. It provides real-time updates to the UI. More...

Inheritance diagram for NetworkMonitor:

Public Member Functions
void	OnPingResponse (int id)
	Handles a received ping response, calculates latency and jitter in ms.
void	StartBandwidthTest ()
	Initiates a bandwidth test by sending a large byte array.
void	StartThroughputTest ()
	Starts a throughput test by sending 100 UDP packets.
void	OnThroughputResposne (int pcktId, int DataSize)
	Called when a response for a throughput packet is received.
float	GetLossPercent ()
float	GetAverageRTT ()
float	GetJitter ()

Private Member Functions
void	Start ()
	Subscribes to client events and starts monitoring after connection.
void	StartMonitor ()
	Starts the latency monitor coroutine.
void	StopMonitoring ()
	Stops all monitoring coroutines and cleanups.
IEnumerator	PingCoroutine ()
	Coroutine that repeatedly sends latency packets and calculate packet loss.
void	SendPing ()
	Sends a latency packet and tracks its send time.
void	CalculateLoss ()
	Calculates packet loss percentage and updates the UI.
void	CleanOldPings ()
	Removes pings that have exceeded the timeout.
float	Average (List< float > list)
	Calculates the average of values in float list.
float	CalculateJitter ()
	Calculates jitter based on differences in RTT samples.
void	OnBandwidthResponse ()
	Called when the server replies to a bandwidth test; calculates and displays bandwidth.
IEnumerator	stopThroughput ()
	Coroutine that stops the throughput test after a fixed time - 5s if not completed.
void	ThroughputCalculate ()
	Finalizes throughput test and updates the UI with results.

Private Attributes
float	pingInterval = 1f
	Interval in seconds between pings sent to measure latency.
float	pingTimeout = 5f
	Timeout in seconds after which a ping is considered lost.
Text	MonitorText1
	UI Text element displaying packet loss, average latency, and jitter.
Text	MonitorText2
	UI Text element displaying bandwidth test result.
Text	MonitorText3
	UI Text element displaying throughput test result.
int	sentPackets = 0
	Total number of latency packets sent.
int	receivedResponses = 0
	Total number of latency responses received.
int	sentPacketsInterval = 0
	Number of latency packets sent during the current interval.
int	receivedResponsesInterval = 0
	Number of responses received during the current interval.
HashSet< int >	awaitingResponses = new()
	Set of IDs for which responses are still pending.
Dictionary< int, float >	sentTimes = new()
	Dictionary storing the send time for each packet ID.
List< float >	latencySamples = new()
	List of recent round-trip time (RTT) samples for calculating average latency and jitter.
float	lastLossPercent = 0f
	Last calculated packet loss percentage.
float	lastJitter = 0f
	Last calculated jitter value.
float	bandwidthClientStartTime
	Timestamp when the bandwidth test started.
int	BandwidthDataSize
	Size in bytes of the bandwidth test data.
Coroutine	pingCoroutine
	Coroutine reference for the ping routine.
Coroutine	throughputTimeoutRoutine
	Coroutine reference for the throughput timeout logic.
float	ThroughputStartTime
int	ThroughputSentSize = 0
int	ThroughputReceivedSize = 0
bool	isThroughputRunning = false
int	ThroughputPacketsReceived = 0

Detailed Description

NetworkMonitor is responsible for actively monitoring network quality metrics such as latency, jitter, packet loss, bandwidth, and throughput. It provides real-time updates to the UI.

Definition at line 10 of file NetworkMonitor.cs.

Member Function Documentation

Average()

float NetworkMonitor.Average ( List< float > list )

private

Calculates the average of values in float list.

Definition at line 208 of file NetworkMonitor.cs.

    {
        float sum = 0f;
        foreach (float entry in list)
            sum += entry;
        return sum / list.Count;
    }

CalculateJitter()

float NetworkMonitor.CalculateJitter ( )

private

Calculates jitter based on differences in RTT samples.

Definition at line 218 of file NetworkMonitor.cs.

    {
        if (latencySamples.Count < 2) return 0f;
 
        float totalDiff = 0f;
        for (int i = 1; i < latencySamples.Count; i++)
            totalDiff += Mathf.Abs(latencySamples[i] - latencySamples[i - 1]);
        return totalDiff / (latencySamples.Count - 1);
    }

CalculateLoss()

void NetworkMonitor.CalculateLoss ( )

private

Calculates packet loss percentage and updates the UI.

Definition at line 165 of file NetworkMonitor.cs.

    {
        int lost = sentPacketsInterval - receivedResponsesInterval;
        if (sentPacketsInterval > 0) {
            lastLossPercent = (float)lost / sentPacketsInterval * 100f;
        } else {
            lastLossPercent = 0f;
        }
 
        float avgRtt;
        if (latencySamples.Count > 0) {
            avgRtt = Average(latencySamples);
        } else {
            avgRtt = 0f;
        }
        MonitorText1.text = ($"[NetworkMonitor] Packet Loss: {lastLossPercent:F2}% | Avg RTT: {avgRtt:F2} ms | Jitter: {lastJitter:F2} ms");
        sentPacketsInterval = 0;
        receivedResponsesInterval = 0;
 
        /*
        File.AppendAllText(pingLog, avgRtt.ToString() + "\n");
        File.AppendAllText(jitterLog, lastJitter.ToString() + "\n");
        File.AppendAllText(packetLossLog, lastLossPercent.ToString() + "\n"); */
    }

CleanOldPings()

void NetworkMonitor.CleanOldPings ( )

private

Removes pings that have exceeded the timeout.

Definition at line 192 of file NetworkMonitor.cs.

    {
        float now = Time.time;
        List<int> expired = new();
        foreach (var sent in sentTimes) {
            if (now - sent.Value > pingTimeout)
                expired.Add(sent.Key);
        }
        foreach (int id in expired) {
            awaitingResponses.Remove(id);
            sentTimes.Remove(id);
        }
    }

GetAverageRTT()

float NetworkMonitor.GetAverageRTT

(

)

Definition at line 324 of file NetworkMonitor.cs.

    {
        float avgRtt;
        if (latencySamples.Count > 0) {
            avgRtt = Average(latencySamples);
        } else {
            avgRtt = 0f;
        }
        return avgRtt;
    }

GetJitter()

float NetworkMonitor.GetJitter

(

)

Definition at line 334 of file NetworkMonitor.cs.

                             {
        return lastJitter ;
    }

GetLossPercent()

float NetworkMonitor.GetLossPercent

(

)

Definition at line 320 of file NetworkMonitor.cs.

    {
        return lastLossPercent;
    }

OnBandwidthResponse()

void NetworkMonitor.OnBandwidthResponse ( )

private

Called when the server replies to a bandwidth test; calculates and displays bandwidth.

Definition at line 242 of file NetworkMonitor.cs.

    {
        float TimeReply = Time.realtimeSinceStartup;
        float duration = TimeReply - bandwidthClientStartTime;
        float bandwidthMbps = (BandwidthDataSize * 8f) / duration / 1_000_000f;
        MonitorText2.text = ($"[BandwidthTest] {bandwidthMbps:F2} Mbps");
       // File.AppendAllText(bandwidthLog, bandwidthMbps.ToString() + "\n");
    }

OnPingResponse()

void NetworkMonitor.OnPingResponse

(

int

id

)

Handles a received ping response, calculates latency and jitter in ms.

Definition at line 146 of file NetworkMonitor.cs.

    {
        if (awaitingResponses.Contains(id) && sentTimes.ContainsKey(id))
        {
            float sentTime = sentTimes[id];
            float rtt = (Time.time - sentTime) * 1000f; 
            latencySamples.Add(rtt);
            if (latencySamples.Count > 10)
                latencySamples.RemoveAt(0);
            receivedResponses++;
            receivedResponsesInterval++;
            awaitingResponses.Remove(id);
            sentTimes.Remove(id);
            lastJitter = CalculateJitter();
        }
    }

OnThroughputResposne()

void NetworkMonitor.OnThroughputResposne	(	int	pcktId,
		int	DataSize )

Called when a response for a throughput packet is received.

Definition at line 287 of file NetworkMonitor.cs.

    {
        ThroughputPacketsReceived++;
        ThroughputReceivedSize += DataSize;
        if(ThroughputPacketsReceived == 100)
        {
            isThroughputRunning = false;
            StopCoroutine(throughputTimeoutRoutine);
            ThroughputCalculate();
        }
    }

PingCoroutine()

IEnumerator NetworkMonitor.PingCoroutine ( )

private

Coroutine that repeatedly sends latency packets and calculate packet loss.

Definition at line 121 of file NetworkMonitor.cs.

    {
        while (true)
        {
            CleanOldPings();
            SendPing();
            yield return new WaitForSeconds(pingInterval);
            CalculateLoss();
        }
    }

SendPing()

void NetworkMonitor.SendPing ( )

private

Sends a latency packet and tracks its send time.

Definition at line 134 of file NetworkMonitor.cs.

    {
        int id = sentPackets++;
        float timeSent = Time.time;
        awaitingResponses.Add(id);
        sentTimes[id] = timeSent;
        sentPacketsInterval++;
        Client.instance.MeassureRequest(id);
    }

Start()

void NetworkMonitor.Start ( )

private

Subscribes to client events and starts monitoring after connection.

Definition at line 94 of file NetworkMonitor.cs.

    {
        Client.instance.OnPingReply += OnPingResponse;
        Client.instance.OnConnected += StartMonitor;
        Client.instance.OnBandwidthReply += OnBandwidthResponse;
        Client.instance.OnThroughputReply += OnThroughputResposne;
        Client.instance.OnDisconnected += StopMonitoring;
    }

StartBandwidthTest()

void NetworkMonitor.StartBandwidthTest

(

)

Initiates a bandwidth test by sending a large byte array.

Definition at line 230 of file NetworkMonitor.cs.

    {
        int sizeKB = 512;
        byte[] data = new byte[sizeKB * 1024];
        new System.Random().NextBytes(data);
        bandwidthClientStartTime = Time.realtimeSinceStartup;
        BandwidthDataSize = data.Length;
        Client.instance.BandwidthRequest(data);
    }

StartMonitor()

void NetworkMonitor.StartMonitor ( )

private

Starts the latency monitor coroutine.

Definition at line 105 of file NetworkMonitor.cs.

    {
        pingCoroutine = StartCoroutine(PingCoroutine());
    }

StartThroughputTest()

void NetworkMonitor.StartThroughputTest

(

)

Starts a throughput test by sending 100 UDP packets.

Definition at line 258 of file NetworkMonitor.cs.

    {
        if (isThroughputRunning)
        {
            Debug.LogWarning("[ThroughputTester] Test already running.");
            return;
        }
        ThroughputPacketsReceived = 0;
        ThroughputSentSize = 0;
        ThroughputReceivedSize = 0;
        isThroughputRunning = true;
        ThroughputStartTime = Time.realtimeSinceStartup;
        throughputTimeoutRoutine = StartCoroutine(stopThroughput());
        for(int i = 1; i<=100; i++)
        { 
            if(!isThroughputRunning)
            {
                ThroughputCalculate();
                break;     
            }
            byte[] data = new byte[1024];
            new System.Random().NextBytes(data);
            ThroughputSentSize += data.Length;
            Client.instance.SendThroughputData(i, data);
        }
    }

StopMonitoring()

void NetworkMonitor.StopMonitoring ( )

private

Stops all monitoring coroutines and cleanups.

Definition at line 112 of file NetworkMonitor.cs.

    {
        StopCoroutine(pingCoroutine);
        if(throughputTimeoutRoutine != null)
        StopCoroutine(throughputTimeoutRoutine);
    }

stopThroughput()

IEnumerator NetworkMonitor.stopThroughput ( )

private

Coroutine that stops the throughput test after a fixed time - 5s if not completed.

Definition at line 301 of file NetworkMonitor.cs.

    {
        yield return new WaitForSeconds(5);
        isThroughputRunning = false;
        ThroughputCalculate();
 
    }

ThroughputCalculate()

void NetworkMonitor.ThroughputCalculate ( )

private

Finalizes throughput test and updates the UI with results.

Definition at line 311 of file NetworkMonitor.cs.

    {
        StopCoroutine(throughputTimeoutRoutine);
        float duration = Time.realtimeSinceStartup - ThroughputStartTime;
        float throughputMbps = (ThroughputReceivedSize * 8f) / duration / 1_000_000f;
        MonitorText3.text = ($"[ThroughputTest] {throughputMbps:F2} Mbps, received {ThroughputPacketsReceived} / 100 packets with size 1024B");
       /* File.AppendAllText(throughputLog, throughputMbps.ToString() + "\n");
        File.AppendAllText("throughput.csv", $"{throughputMbps:F2};{ThroughputReceivedSize};{duration:F3}\n"); */
    }

Member Data Documentation

awaitingResponses

HashSet<int> NetworkMonitor.awaitingResponses = new()

private

Set of IDs for which responses are still pending.

Definition at line 51 of file NetworkMonitor.cs.

bandwidthClientStartTime

float NetworkMonitor.bandwidthClientStartTime

private

Timestamp when the bandwidth test started.

Definition at line 71 of file NetworkMonitor.cs.

BandwidthDataSize

int NetworkMonitor.BandwidthDataSize

private

Size in bytes of the bandwidth test data.

Definition at line 75 of file NetworkMonitor.cs.

isThroughputRunning

bool NetworkMonitor.isThroughputRunning = false

private

Definition at line 253 of file NetworkMonitor.cs.

lastJitter

float NetworkMonitor.lastJitter = 0f

private

Last calculated jitter value.

Definition at line 67 of file NetworkMonitor.cs.

lastLossPercent

float NetworkMonitor.lastLossPercent = 0f

private

Last calculated packet loss percentage.

Definition at line 63 of file NetworkMonitor.cs.

latencySamples

List<float> NetworkMonitor.latencySamples = new()

private

List of recent round-trip time (RTT) samples for calculating average latency and jitter.

Definition at line 59 of file NetworkMonitor.cs.

MonitorText1

Text NetworkMonitor.MonitorText1

private

UI Text element displaying packet loss, average latency, and jitter.

Definition at line 23 of file NetworkMonitor.cs.

MonitorText2

Text NetworkMonitor.MonitorText2

private

UI Text element displaying bandwidth test result.

Definition at line 27 of file NetworkMonitor.cs.

MonitorText3

Text NetworkMonitor.MonitorText3

private

UI Text element displaying throughput test result.

Definition at line 31 of file NetworkMonitor.cs.

pingCoroutine

Coroutine NetworkMonitor.pingCoroutine

private

Coroutine reference for the ping routine.

Definition at line 79 of file NetworkMonitor.cs.

pingInterval

float NetworkMonitor.pingInterval = 1f

private

Interval in seconds between pings sent to measure latency.

Definition at line 15 of file NetworkMonitor.cs.

pingTimeout

float NetworkMonitor.pingTimeout = 5f

private

Timeout in seconds after which a ping is considered lost.

Definition at line 19 of file NetworkMonitor.cs.

receivedResponses

int NetworkMonitor.receivedResponses = 0

private

Total number of latency responses received.

Definition at line 39 of file NetworkMonitor.cs.

receivedResponsesInterval

int NetworkMonitor.receivedResponsesInterval = 0

private

Number of responses received during the current interval.

Definition at line 47 of file NetworkMonitor.cs.

sentPackets

int NetworkMonitor.sentPackets = 0

private

Total number of latency packets sent.

Definition at line 35 of file NetworkMonitor.cs.

sentPacketsInterval

int NetworkMonitor.sentPacketsInterval = 0

private

Number of latency packets sent during the current interval.

Definition at line 43 of file NetworkMonitor.cs.

sentTimes

Dictionary<int, float> NetworkMonitor.sentTimes = new()

private

Dictionary storing the send time for each packet ID.

Definition at line 55 of file NetworkMonitor.cs.

ThroughputPacketsReceived

int NetworkMonitor.ThroughputPacketsReceived = 0

private

Definition at line 254 of file NetworkMonitor.cs.

ThroughputReceivedSize

int NetworkMonitor.ThroughputReceivedSize = 0

private

Definition at line 252 of file NetworkMonitor.cs.

ThroughputSentSize

int NetworkMonitor.ThroughputSentSize = 0

private

Definition at line 251 of file NetworkMonitor.cs.

ThroughputStartTime

float NetworkMonitor.ThroughputStartTime

private

Definition at line 250 of file NetworkMonitor.cs.

throughputTimeoutRoutine

Coroutine NetworkMonitor.throughputTimeoutRoutine

private

Coroutine reference for the throughput timeout logic.

Definition at line 83 of file NetworkMonitor.cs.