Class UNetTransport

Inheritance
object
Object
Component
Behaviour
MonoBehaviour
NetworkTransport
UNetTransport
Implements
Inherited Members
Namespace: MLAPI.Transports.UNET
Assembly: Unity.Multiplayer.MLAPI.Runtime.dll
Syntax
public class UNetTransport : NetworkTransport, ITransportProfilerData

Fields

Channels

Declaration
public List<UNetChannel> Channels
Field Value
Type Description
List<UNetChannel>

ConnectAddress

Declaration
public string ConnectAddress
Field Value
Type Description
string

ConnectPort

Declaration
public int ConnectPort
Field Value
Type Description
int

MLAPIRelayAddress

Declaration
public string MLAPIRelayAddress
Field Value
Type Description
string

MLAPIRelayPort

Declaration
public int MLAPIRelayPort
Field Value
Type Description
int

MaxConnections

Declaration
public int MaxConnections
Field Value
Type Description
int

MaxSentMessageQueueSize

Declaration
public int MaxSentMessageQueueSize
Field Value
Type Description
int

MessageBufferSize

Declaration
public int MessageBufferSize
Field Value
Type Description
int

MessageSendMode

Declaration
public UNetTransport.SendMode MessageSendMode
Field Value
Type Description
UNetTransport.SendMode

ProfilerEnabled

Declaration
public static bool ProfilerEnabled
Field Value
Type Description
bool

ServerListenPort

Declaration
public int ServerListenPort
Field Value
Type Description
int

ServerWebsocketListenPort

Declaration
public int ServerWebsocketListenPort
Field Value
Type Description
int

SupportWebsocket

Declaration
public bool SupportWebsocket
Field Value
Type Description
bool

UseMLAPIRelay

Declaration
public bool UseMLAPIRelay
Field Value
Type Description
bool

Properties

ServerClientId

A constant clientId that represents the server. When this value is found in methods such as Send, it should be treated as a placeholder that means "the server"

Declaration
public override ulong ServerClientId { get; }
Property Value
Type Description
ulong
Overrides

Methods

AddMLAPIChannel(NetworkDelivery, ConnectionConfig)

Declaration
public int AddMLAPIChannel(NetworkDelivery type, ConnectionConfig config)
Parameters
Type Name Description
NetworkDelivery type
ConnectionConfig config
Returns
Type Description
int

AddUNETChannel(QosType, ConnectionConfig)

Declaration
public int AddUNETChannel(QosType type, ConnectionConfig config)
Parameters
Type Name Description
QosType type
ConnectionConfig config
Returns
Type Description
int

BeginNewTick()

Declaration
public void BeginNewTick()

DisconnectLocalClient()

Disconnects the local client from the server

Declaration
public override void DisconnectLocalClient()
Overrides

DisconnectRemoteClient(ulong)

Disconnects a client from the server

Declaration
public override void DisconnectRemoteClient(ulong clientId)
Parameters
Type Name Description
ulong clientId

The clientId to disconnect
Overrides

GetConfig()

Declaration
public ConnectionConfig GetConfig()
Returns
Type Description
ConnectionConfig

GetCurrentRtt(ulong)

Gets the round trip time for a specific client. This method is optional

Declaration
public override ulong GetCurrentRtt(ulong clientId)
Parameters
Type Name Description
ulong clientId

The clientId to get the rtt from
Returns
Type Description
ulong

Returns the round trip time in milliseconds
Overrides

GetMLAPIClientId(byte, ushort, bool)

Declaration
public ulong GetMLAPIClientId(byte hostId, ushort connectionId, bool isServer)
Parameters
Type Name Description
byte hostId
ushort connectionId
bool isServer
Returns
Type Description
ulong

GetTransportProfilerData()

Declaration
public IReadOnlyDictionary<string, int> GetTransportProfilerData()
Returns
Type Description
IReadOnlyDictionary<string, int>

GetUNetConnectionDetails(ulong, out byte, out ushort)

Declaration
public void GetUNetConnectionDetails(ulong clientId, out byte hostId, out ushort connectionId)
Parameters
Type Name Description
ulong clientId
byte hostId
ushort connectionId

Init()

Initializes the transport

Declaration
public override void Init()
Overrides

LateUpdate()

Declaration
protected void LateUpdate()

PollEvent(out ulong, out NetworkChannel, out ArraySegment<byte>, out float)

Polls for incoming events, with an extra output parameter to report the precise time the event was received.

Declaration
public override NetworkEvent PollEvent(out ulong clientId, out NetworkChannel networkChannel, out ArraySegment<byte> payload, out float receiveTime)
Parameters
Type Name Description
ulong clientId

The clientId this event is for
NetworkChannel networkChannel
ArraySegment<byte> payload

The incoming data payload
float receiveTime

The time the event was received, as reported by Time.realtimeSinceStartup.
Returns
Type Description
NetworkEvent

Returns the event type
Overrides

Send(ulong, ArraySegment<byte>, NetworkChannel)

Send a payload to the specified clientId, data and channelName.

Declaration
public override void Send(ulong clientId, ArraySegment<byte> data, NetworkChannel networkChannel)
Parameters
Type Name Description
ulong clientId

The clientId to send to
ArraySegment<byte> data

The data to send
NetworkChannel networkChannel
Overrides

SendQueued(ulong)

Declaration
public void SendQueued(ulong clientId)
Parameters
Type Name Description
ulong clientId

Shutdown()

Shuts down the transport

Declaration
public override void Shutdown()
Overrides

StartClient()

Connects client to server

Declaration
public override SocketTasks StartClient()
Returns
Type Description
SocketTasks
Overrides

StartServer()

Starts to listen for incoming clients.

Declaration
public override SocketTasks StartServer()
Returns
Type Description
SocketTasks
Overrides

Implements