charleslemaux/Mirror
1
0
Fork 0
mirror of https://github.com/MirrorNetworking/Mirror.git synced 2024-11-18 02:50:32 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Transport syntax: group fields together

Browse Source
This commit is contained in:
vis2k 2022-05-12 12:36:48 +08:00
parent 91e2a0f79b
commit a2d35b82b6
1 changed files with 25 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
Assets/Mirror/Runtime/Transport.cs
View File

@ -30,12 +30,14 @@ namespace Mirror
/// <summary>Abstract transport layer component</summary>
public abstract class Transport : MonoBehaviour
{
// common //////////////////////////////////////////////////////////////
/// <summary>The current transport used by Mirror.</summary>
public static Transport activeTransport;
/// <summary>Is this transport available in the current platform?</summary>
public abstract bool Available();
// client //////////////////////////////////////////////////////////////
/// <summary>Called by Transport when the client connected to the server.</summary>
public Action OnClientConnected;
@ -55,6 +57,28 @@ public abstract class Transport : MonoBehaviour
/// <summary>Called by Transport when the client disconnected from the server.</summary>
public Action OnClientDisconnected;
// server //////////////////////////////////////////////////////////////
/// <summary>Called by Transport when a new client connected to the server.</summary>
public Action<int> OnServerConnected;
/// <summary>Called by Transport when the server received a message from a client.</summary>
public Action<int, ArraySegment<byte>, int> OnServerDataReceived;
/// <summary>Called by Transport when the server sent a message to a client.</summary>
// Transports are responsible for calling it because:
// - groups it together with OnReceived responsibility
// - allows transports to decide if anything was sent or not
// - allows transports to decide the actual used channel (i.e. tcp always sending reliable)
public Action<int, ArraySegment<byte>, int> OnServerDataSent;
/// <summary>Called by Transport when a server's connection encountered a problem.</summary>
/// If a Disconnect will also be raised, raise the Error first.
public Action<int, Exception> OnServerError;
/// <summary>Called by Transport when a client disconnected from the server.</summary>
public Action<int> OnServerDisconnected;
// client functions ////////////////////////////////////////////////////
/// <summary>True if the client is currently connected to the server.</summary>
public abstract bool ClientConnected();
@ -76,30 +100,11 @@ public virtual void ClientConnect(Uri uri)
/// <summary>Disconnects the client from the server</summary>
public abstract void ClientDisconnect();
// server functions ////////////////////////////////////////////////////
/// <summary>Returns server address as Uri.</summary>
// Useful for NetworkDiscovery.
public abstract Uri ServerUri();
/// <summary>Called by Transport when a new client connected to the server.</summary>
public Action<int> OnServerConnected;
/// <summary>Called by Transport when the server received a message from a client.</summary>
public Action<int, ArraySegment<byte>, int> OnServerDataReceived;
/// <summary>Called by Transport when the server sent a message to a client.</summary>
// Transports are responsible for calling it because:
// - groups it together with OnReceived responsibility
// - allows transports to decide if anything was sent or not
// - allows transports to decide the actual used channel (i.e. tcp always sending reliable)
public Action<int, ArraySegment<byte>, int> OnServerDataSent;
/// <summary>Called by Transport when a server's connection encountered a problem.</summary>
/// If a Disconnect will also be raised, raise the Error first.
public Action<int, Exception> OnServerError;
/// <summary>Called by Transport when a client disconnected from the server.</summary>
public Action<int> OnServerDisconnected;
/// <summary>True if the server is currently listening for connections.</summary>
public abstract bool ServerActive();