Skip to main content

Unity.Networking.Transport.IPCNetworkInterface

The ipc network interface

Implements#

INetworkInterface

System.IDisposable

Inherited Members#

ValueType.Equals(Object)

ValueType.GetHashCode()

ValueType.ToString()

Object.Equals(Object, Object)

Object.GetType()

Object.ReferenceEquals(Object, Object)

Namespace: System.Dynamic.ExpandoObject#
Assembly: transport.dll#
Syntax#
public struct IPCNetworkInterface : INetworkInterface, IDisposable

LocalEndPoint#

Gets the value of the local end point

Declaration#

public readonly NetworkInterfaceEndPoint LocalEndPoint { get; }

Property Value#

TypeDescription
NetworkInterfaceEndPoint

#

Bind(NetworkInterfaceEndPoint)#

Binds the medium to a specific endpoint.

Declaration#

public int Bind(NetworkInterfaceEndPoint endpoint)

Parameters#

TypeNameDescription
NetworkInterfaceEndPointendpointA valid NetworkInterfaceEndPoint.

Returns#

TypeDescription
System.Int320 on Success

CreateInterfaceEndPoint(NetworkEndPoint, out NetworkInterfaceEndPoint)#

Creates an interface end point. Only available for loopback addresses.

Declaration#

public int CreateInterfaceEndPoint(NetworkEndPoint address, out NetworkInterfaceEndPoint endpoint)

Parameters#

TypeNameDescription
NetworkEndPointaddressLoopback address
NetworkInterfaceEndPointendpointThe endpoint

Returns#

TypeDescription
System.Int32The status code of the result, 0 being a success.

CreateSendInterface()#

Creates the send interface

Declaration#

public NetworkSendInterface CreateSendInterface()

Returns#

TypeDescription
NetworkSendInterfaceThe network send interface

Dispose()#

Cleans up both the local end point and the IPCManager instance.

Declaration#

public void Dispose()

GetGenericEndPoint(NetworkInterfaceEndPoint)#

Retrieves an already created endpoint with port or creates one.

Declaration#

public NetworkEndPoint GetGenericEndPoint(NetworkInterfaceEndPoint endpoint)

Parameters#

TypeNameDescription
NetworkInterfaceEndPointendpointThe loopback endpoint

Returns#

TypeDescription
NetworkEndPointNetworkEndPoint

Initialize(INetworkParameter[])#

Initializes the interface passing in optional INetworkParameter

Declaration#

public int Initialize(params INetworkParameter[] param)

Parameters#

TypeNameDescription
INetworkParameter[]paramThe param

Returns#

TypeDescription
System.Int32The status code of the result, 0 being a success.

Listen()#

Start listening for incoming connections. This is normally a no-op for real UDP sockets.

Declaration#

public int Listen()

Returns#

TypeDescription
System.Int320 on Success

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#

public JobHandle ScheduleReceive(NetworkPacketReceiver receiver, JobHandle dep)

Parameters#

TypeNameDescription
NetworkPacketReceiverreceiverA NetworkDriver used to parse the data received.
JobHandledepA to any dependency we might have.

Returns#

TypeDescription
JobHandleA 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#

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

Parameters#

TypeNameDescription
NativeQueue\<QueuedSendMessage>sendQueueThe send queue which can be used to emulate parallel send.
JobHandledepA to any dependency we might have.

Returns#

TypeDescription
JobHandleA to our newly created ScheduleSend Job.

Implements#

INetworkInterface

System.IDisposable