Interface INetworkInterface

Namespace: Unity.Networking.Transport

Syntax

public interface INetworkInterface : IDisposable

Properties

LocalEndPoint

Declaration

NetworkInterfaceEndPoint LocalEndPoint { get; }

Property Value

Type	Description
NetworkInterfaceEndPoint

Methods

Bind(NetworkInterfaceEndPoint)

Binds the medium to a specific endpoint.

Declaration

int Bind(NetworkInterfaceEndPoint endpoint)

Parameters

Type	Name	Description
NetworkInterfaceEndPoint	endpoint	A valid NetworkInterfaceEndPoint.

Returns

Type	Description
Int32	0 on Success

CreateInterfaceEndPoint(NetworkEndPoint)

Declaration

NetworkInterfaceEndPoint CreateInterfaceEndPoint(NetworkEndPoint endPoint)

Parameters

Type	Name	Description
NetworkEndPoint	endPoint

Returns

Type	Description
NetworkInterfaceEndPoint

CreateSendInterface()

Declaration

NetworkSendInterface CreateSendInterface()

Returns

Type	Description
NetworkSendInterface

GetGenericEndPoint(NetworkInterfaceEndPoint)

Declaration

NetworkEndPoint GetGenericEndPoint(NetworkInterfaceEndPoint endpoint)

Parameters

Type	Name	Description
NetworkInterfaceEndPoint	endpoint

Returns

Type	Description
NetworkEndPoint

Initialize(INetworkParameter[])

Declaration

void Initialize(params INetworkParameter[] param)

Parameters

Type	Name	Description
INetworkParameter[]	param

ScheduleReceive(NetworkPacketReceiver, JobHandle)

Schedule a ReceiveJob. This is used to read data from your supported medium and pass it to the AppendData function supplied by NetworkDriver

Declaration

JobHandle ScheduleReceive(NetworkPacketReceiver receiver, JobHandle dep)

Parameters

Type	Name	Description
NetworkPacketReceiver	receiver	A NetworkDriver used to parse the data received.
JobHandle	dep	A JobHandle to any dependency we might have.

Returns

Type	Description
JobHandle	A JobHandle to our newly created ScheduleReceive Job.

ScheduleSend(NativeQueue<QueuedSendMessage>, JobHandle)

Schedule a SendJob. This is used to flush send queues to your supported medium

Declaration

JobHandle ScheduleSend(NativeQueue<QueuedSendMessage> sendQueue, JobHandle dep)

Parameters

Type	Name	Description
NativeQueue<QueuedSendMessage>	sendQueue	The send queue which can be used to emulate parallel send.
JobHandle	dep	A JobHandle to any dependency we might have.

Returns

Type	Description
JobHandle	A JobHandle to our newly created ScheduleSend Job.