Client Class Reference

Main MonoBehaviour singleton class handling the client-side networking logic (TCP, UDP) in Unity. More...

Inheritance diagram for Client:

Classes
class	TCP
	Handles TCP connection. More...
class	UDP
	Handles UDP connection and communication for the client. More...

Public Member Functions
bool	IsLocal (int checkId)
	Checks if the specified ID belongs to this local client.
void	SetToken (string token)
	Sets the authentication token.
string	GetToken ()
	Gets the authentication token.
byte[]	GetHmacKey ()
	Gets the HMAC key used for secure communication.
void	SetHmacKey (byte[] newHmacKey)
	Sets the HMAC key for secure communication.
string	GetUsername ()
	Gets the current username.
void	SetUsername (string newUsername)
	Sets the current username.
int	GetId ()
	Gets the current client ID.
void	SetId (int newId)
	Sets the client ID.
DefaultNetworkSettings	GetDefaultSettings ()
	Gets default network settings used for connection.
void	ConnectToServer ()
	Starts the connection process to the server.
void	Disconnect ()
	Disconnects the client from the server.
void	ResetNetwork ()
	Resets client network components and reloads the initial scene.
void	MeassureRequest (int pcktId)
	Sends a ping measurement request to the server.
void	MeassureAnswer (int pcktId)
	Handles the server’s ping reply and triggers the ping event.
void	DisconnectRequested ()
	Sends a disconnect request to the server.
void	DisconnectOther (int clientid)
	Disconnects another user with the given ID from the scene.
void	MessageToUserRequest (string message, int clientId)
	Sends a message to a specific user.
void	MessageToAllRequest (string message)
	Sends a message to all users in the session.
void	SpawnUserPrefab (int id, string username)
	Spawns the user prefab locally or remotely.
void	ReceivedMessage (string message)
	Triggers message-received event with the given message.
void	UpdateTransform (Transform objectTransform)
	Sends current transform of a game object to the server.
void	ChangeTransform (int id, Vector3 pos, Quaternion rot)
	Updates the transform of a remote player.
void	AnimationUpdate (int type, string name, float value)
	Sends animation update to the server.
void	ChangeAnimatorState (int id, int type, string name, float value)
	Applies received animation state from the server.
void	BandwidthRequest (byte[] data)
	Sends request to measure bandwidth to the server.
void	SendThroughputData (int pcktId, byte[] data)
	Sends a packet of data to test throughput.
void	ReceivedBandwidth ()
	Called when bandwidth reply is received from the server.
void	ReceivedThroughput (int pcktId, int dataSize)
	Called when throughput test result is received.

Static Public Member Functions
static void	PacketAction (int packetId, Packet packet)
	Handles the received packet by type by calling methods in ClientReceiveHandler.

Public Attributes
TCP	tcp
	Handles TCP communication with the server.
UDP	udp
	Handles UDP communication with the server.
bool	isConnected = false
	Indicates whether the client is currently connected to the server.

Static Public Attributes
static Client	instance
	Singleton instance of the client.

Events
Action	OnConnected
	Event triggered when the client successfully connects to the server.
Action< string >	OnConnectionFailed
	Event triggered when the client fails to connect, providing an error message.
Action	OnDisconnected
	Event triggered when the client is disconnected from the server.
Action< string >	OnMessageReceived
	Event triggered when a text message is received from the server.
Action< int, Vector3, Quaternion >	OnTransformReceived
	Event triggered when a transform update is received.
Action< int, int, string, float >	OnAnimationChangeReceived
	Event triggered when an animation update is received.
Action< int >	OnPingReply
	Event triggered when a ping response is received.
Action	OnBandwidthReply
	Event triggered when the bandwidth test result is received.
Action< int, int >	OnThroughputReply
	Event triggered when throughput test results are received.

Private Member Functions
void	Awake ()
	Ensures only one instance of the client exists (Singleton pattern).
void	OnApplicationQuit ()
	Disconnects the client when the application quits.
void	SetClient ()
	Initializes TCP and UDP communication handlers for this client.

Private Attributes
DefaultNetworkSettings	defaultNetworkSettings
	Network settings shared between client and server (IP, port, security, ...).
ClientSettings	ClientSettings
	Client-specific configuration used during runtime.
int	id = 0
	The unique client id assigned by the server.
string	username = ""
	The current username of the client.
Coroutine	latencyMeassure
	Reference to the coroutine responsible for measuring latency.
byte[]	hmacKey
	HMAC key used for message authentication.
string	authToken
	Authentication token used to verify client identity.

Static Private Attributes
static int	DefaultBufferSize = 4096
	Default buffer size used for sending and receiving data (in bytes).

Detailed Description

Main MonoBehaviour singleton class handling the client-side networking logic (TCP, UDP) in Unity.

Definition at line 15 of file Client.cs.

Member Function Documentation

AnimationUpdate()

void Client.AnimationUpdate	(	int	type,
		string	name,
		float	value )

Sends animation update to the server.

Definition at line 677 of file Client.cs.

    {
        ClientSendHandler.SendAnimationUpdate(type, name, value);
    }

Awake()

void Client.Awake ( )

private

Ensures only one instance of the client exists (Singleton pattern).

Definition at line 104 of file Client.cs.

    {
        if(instance == null)
        {
            instance = this;
        } 
        else if(instance != this)
        {
            Destroy(this);
        }
    }

BandwidthRequest()

void Client.BandwidthRequest

(

byte[]

data

)

Sends request to measure bandwidth to the server.

Definition at line 691 of file Client.cs.

    {
        ClientSendHandler.SendBandwidthRequest(data);
    }

ChangeAnimatorState()

void Client.ChangeAnimatorState	(	int	id,
		int	type,
		string	name,
		float	value )

Applies received animation state from the server.

Definition at line 684 of file Client.cs.

    {
        instance.OnAnimationChangeReceived?.Invoke(id, type, name, value);
    }

ChangeTransform()

void Client.ChangeTransform	(	int	id,
		Vector3	pos,
		Quaternion	rot )

Updates the transform of a remote player.

Definition at line 670 of file Client.cs.

    {
        instance.OnTransformReceived?.Invoke(id, pos, rot);
    }

ConnectToServer()

void Client.ConnectToServer

(

)

Starts the connection process to the server.

Definition at line 283 of file Client.cs.

    {
        SetClient();
        tcp.Connect();
    }

Disconnect()

void Client.Disconnect

(

)

Disconnects the client from the server.

Definition at line 555 of file Client.cs.

    {
        if (isConnected == true)
        {
            isConnected = false;
            tcp.Socket.Close();
            udp.Socket.Close();
            ThreadsController.StartOnMainThread(() =>
            {
                ResetNetwork();
            });
            instance.OnDisconnected?.Invoke();
        }
    }

DisconnectOther()

void Client.DisconnectOther

(

int

clientid

)

Disconnects another user with the given ID from the scene.

Definition at line 616 of file Client.cs.

    {
        NetworkManager.networkManager.DisconnectForeignUser(clientid);
    }

DisconnectRequested()

void Client.DisconnectRequested

(

)

Sends a disconnect request to the server.

Definition at line 606 of file Client.cs.

    {
        if(isConnected == true)
        {
            ClientSendHandler.DisconnectRequest();
        }
    }

GetDefaultSettings()

DefaultNetworkSettings Client.GetDefaultSettings

(

)

Gets default network settings used for connection.

Definition at line 185 of file Client.cs.

    {
        return defaultNetworkSettings;
    }

GetHmacKey()

byte[] Client.GetHmacKey

(

)

Gets the HMAC key used for secure communication.

Definition at line 143 of file Client.cs.

    {
        return hmacKey;
    }

GetId()

int Client.GetId

(

)

Gets the current client ID.

Definition at line 171 of file Client.cs.

    {
        return id;
    }

GetToken()

string Client.GetToken

(

)

Gets the authentication token.

Definition at line 136 of file Client.cs.

    {
        return authToken;
    }

GetUsername()

string Client.GetUsername

(

)

Gets the current username.

Definition at line 157 of file Client.cs.

    {
        return username;
    }

IsLocal()

bool Client.IsLocal

(

int

checkId

)

Checks if the specified ID belongs to this local client.

Definition at line 118 of file Client.cs.

    {
        if(id == checkId) {
            return true;
        } else {
            return false;
        }
    }

MeassureAnswer()

void Client.MeassureAnswer

(

int

pcktId

)

Handles the server’s ping reply and triggers the ping event.

Definition at line 599 of file Client.cs.

    {
        instance.OnPingReply?.Invoke(pcktId);
    }

MeassureRequest()

void Client.MeassureRequest

(

int

pcktId

)

Sends a ping measurement request to the server.

Definition at line 589 of file Client.cs.

    {
        if(isConnected == true)
        {
            ClientSendHandler.MeassureRequest(pcktId);
        } 
    }

MessageToAllRequest()

void Client.MessageToAllRequest

(

string

message

)

Sends a message to all users in the session.

Definition at line 633 of file Client.cs.

    {
        if(isConnected == true)
        {
            ClientSendHandler.MessageToAllRequest(message);
        }
    }

MessageToUserRequest()

void Client.MessageToUserRequest	(	string	message,
		int	clientId )

Sends a message to a specific user.

Definition at line 623 of file Client.cs.

    {
        if(isConnected == true)
        {
            ClientSendHandler.MessageToUserRequest(message, clientId);
        }
    }

OnApplicationQuit()

void Client.OnApplicationQuit ( )

private

Disconnects the client when the application quits.

Definition at line 192 of file Client.cs.

    {
        Disconnect();
    }

PacketAction()

void Client.PacketAction ( int packetId, Packet packet )

static

Handles the received packet by type by calling methods in ClientReceiveHandler.

Definition at line 215 of file Client.cs.

    {
        if (!Enum.IsDefined(typeof(Packet.ServerPackets), packetId))
        {
            Debug.LogWarning($"Unknown packet ID: {packetId}");
            return;
        }
 
        Packet.ServerPackets packetType = (Packet.ServerPackets)packetId;
 
        switch (packetType)
        {
            case Packet.ServerPackets.welcome:
                ClientReceiveHandler.Welcome(packet);
                break;
 
            case Packet.ServerPackets.SpawnUser:
                ClientReceiveHandler.SpawnUser(packet);
                break;
 
            case Packet.ServerPackets.DisconnectUser:
                ClientReceiveHandler.DisconnectUser(packet);
                break;
 
            case Packet.ServerPackets.Latency:
                ClientReceiveHandler.Latency(packet);
                break;
 
            case Packet.ServerPackets.Message:
                ClientReceiveHandler.ReceiveMessage(packet);
                break;
 
            case Packet.ServerPackets.HmacKey:
                ClientReceiveHandler.ReceiveHmacKey(packet);
                break;
 
            case Packet.ServerPackets.AuthToken:
                ClientReceiveHandler.ReceiveToken(packet);
                break;
 
            case Packet.ServerPackets.MessageAll:
                ClientReceiveHandler.ReceiveMessageAll(packet);
                break;
 
            case Packet.ServerPackets.TransformUpdate:
                ClientReceiveHandler.TransformUpdate(packet);
                break;
 
            case Packet.ServerPackets.AnimationUpdate:
                ClientReceiveHandler.AnimationUpdate(packet);
                break;
 
            case Packet.ServerPackets.BandwidthReply:
                ClientReceiveHandler.BandwidthReply(packet);
                break;
 
            case Packet.ServerPackets.ThroughputReply:
                ClientReceiveHandler.ThroughputReply(packet);
                break;
 
            default:
                Debug.LogWarning($"Unhandled packet type: {packetType}");
                break;
        }
    }

ReceivedBandwidth()

void Client.ReceivedBandwidth

(

)

Called when bandwidth reply is received from the server.

Definition at line 705 of file Client.cs.

    {
        instance.OnBandwidthReply?.Invoke();
    }

ReceivedMessage()

void Client.ReceivedMessage

(

string

message

)

Triggers message-received event with the given message.

Definition at line 656 of file Client.cs.

    {
        instance.OnMessageReceived?.Invoke(message);
    }

ReceivedThroughput()

void Client.ReceivedThroughput	(	int	pcktId,
		int	dataSize )

Called when throughput test result is received.

Definition at line 712 of file Client.cs.

    {
        instance.OnThroughputReply?.Invoke(pcktId, dataSize);
    }

ResetNetwork()

void Client.ResetNetwork

(

)

Resets client network components and reloads the initial scene.

This can be changed.

Definition at line 572 of file Client.cs.

    {
        Disconnect();
        if (latencyMeassure != null)
        {
            StopCoroutine(latencyMeassure);
            latencyMeassure = null;
        }
        SetClient();
        SceneManager.LoadScene(0);
    }

SendThroughputData()

void Client.SendThroughputData	(	int	pcktId,
		byte[]	data )

Sends a packet of data to test throughput.

Definition at line 698 of file Client.cs.

    {
        ClientSendHandler.SendThroughputRequest(pcktId, data);
    }

SetClient()

void Client.SetClient ( )

private

Initializes TCP and UDP communication handlers for this client.

Definition at line 199 of file Client.cs.

    {
        if (tcp != null)
        {
            tcp = null;
        }
        if (udp != null)
        {
            udp = null;
        }
        tcp = new TCP();
        udp = new UDP();
    }

SetHmacKey()

void Client.SetHmacKey

(

byte[]

newHmacKey

)

Sets the HMAC key for secure communication.

Definition at line 150 of file Client.cs.

    {
        hmacKey = newHmacKey;
    }

SetId()

void Client.SetId

(

int

newId

)

Sets the client ID.

Definition at line 178 of file Client.cs.

    {
        id = newId;
    }

SetToken()

void Client.SetToken

(

string

token

)

Sets the authentication token.

Definition at line 129 of file Client.cs.

    {
        authToken = token;
    }

SetUsername()

void Client.SetUsername

(

string

newUsername

)

Sets the current username.

Definition at line 164 of file Client.cs.

    {
        username = newUsername;
    }

SpawnUserPrefab()

void Client.SpawnUserPrefab	(	int	id,
		string	username )

Spawns the user prefab locally or remotely.

Definition at line 643 of file Client.cs.

    {
        if (id == instance.GetId())
        {
            NetworkManager.networkManager.SpawnUser(id,username,true);
        } else
        {
            NetworkManager.networkManager.SpawnUser(id, username, false);
        }
    }

UpdateTransform()

void Client.UpdateTransform

(

Transform

objectTransform

)

Sends current transform of a game object to the server.

Definition at line 663 of file Client.cs.

    {
        ClientSendHandler.SendTransform(instance.GetId(), objectTransform);
    }

Member Data Documentation

authToken

string Client.authToken

private

Authentication token used to verify client identity.

Definition at line 64 of file Client.cs.

ClientSettings

ClientSettings Client.ClientSettings

private

Client-specific configuration used during runtime.

Definition at line 32 of file Client.cs.

DefaultBufferSize

int Client.DefaultBufferSize = 4096

staticprivate

Default buffer size used for sending and receiving data (in bytes).

Definition at line 24 of file Client.cs.

defaultNetworkSettings

DefaultNetworkSettings Client.defaultNetworkSettings

private

Network settings shared between client and server (IP, port, security, ...).

Definition at line 28 of file Client.cs.

hmacKey

byte [] Client.hmacKey

private

HMAC key used for message authentication.

Definition at line 60 of file Client.cs.

id

int Client.id = 0

private

The unique client id assigned by the server.

Definition at line 36 of file Client.cs.

instance

Client Client.instance

static

Singleton instance of the client.

Definition at line 20 of file Client.cs.

isConnected

bool Client.isConnected = false

Indicates whether the client is currently connected to the server.

Definition at line 52 of file Client.cs.

latencyMeassure

Coroutine Client.latencyMeassure

private

Reference to the coroutine responsible for measuring latency.

Definition at line 56 of file Client.cs.

tcp

TCP Client.tcp

Handles TCP communication with the server.

Definition at line 44 of file Client.cs.

udp

UDP Client.udp

Handles UDP communication with the server.

Definition at line 48 of file Client.cs.

username

string Client.username = ""

private

The current username of the client.

Definition at line 40 of file Client.cs.

Event Documentation

OnAnimationChangeReceived

Action<int,int, string, float> Client.OnAnimationChangeReceived

Event triggered when an animation update is received.

Definition at line 88 of file Client.cs.

OnBandwidthReply

Action Client.OnBandwidthReply

Event triggered when the bandwidth test result is received.

Definition at line 96 of file Client.cs.

OnConnected

Action Client.OnConnected

Event triggered when the client successfully connects to the server.

Definition at line 68 of file Client.cs.

OnConnectionFailed

Action<string> Client.OnConnectionFailed

Event triggered when the client fails to connect, providing an error message.

Definition at line 72 of file Client.cs.

OnDisconnected

Action Client.OnDisconnected

Event triggered when the client is disconnected from the server.

Definition at line 76 of file Client.cs.

OnMessageReceived

Action<string> Client.OnMessageReceived

Event triggered when a text message is received from the server.

Definition at line 80 of file Client.cs.

OnPingReply

Action<int> Client.OnPingReply

Event triggered when a ping response is received.

Definition at line 92 of file Client.cs.

OnThroughputReply

Action<int,int> Client.OnThroughputReply

Event triggered when throughput test results are received.

Definition at line 100 of file Client.cs.

OnTransformReceived

Action<int,Vector3,Quaternion> Client.OnTransformReceived

Event triggered when a transform update is received.

Definition at line 84 of file Client.cs.