Struct IPCNetworkInterface
The ipc network interface
Inherited Members
Namespace: Unity.Networking.Transport
Syntax
[BurstCompile]
public struct IPCNetworkInterface : INetworkInterface, IDisposableProperties
LocalEndPoint
Gets the value of the local end point
Declaration
public readonly NetworkInterfaceEndPoint LocalEndPoint { get; }Property Value
| Type | Description |
|---|---|
| NetworkInterfaceEndPoint |
Implements
Methods
Bind(NetworkInterfaceEndPoint)
Binds the medium to a specific endpoint.
Declaration
public int Bind(NetworkInterfaceEndPoint endpoint)Parameters
| Type | Name | Description |
|---|---|---|
| NetworkInterfaceEndPoint | endpoint | A valid NetworkInterfaceEndPoint. |
Returns
| Type | Description |
|---|---|
| Int32 | 0 on Success |
Implements
CreateInterfaceEndPoint(NetworkEndPoint, out NetworkInterfaceEndPoint)
Creates an interface end point. Only available for loopback addresses.
Declaration
public int CreateInterfaceEndPoint(NetworkEndPoint address, out NetworkInterfaceEndPoint endpoint)Parameters
| Type | Name | Description |
|---|---|---|
| NetworkEndPoint | address | Loopback address |
| NetworkInterfaceEndPoint | endpoint | The endpoint |
Returns
| Type | Description |
|---|---|
| Int32 | The status code of the result, 0 being a success. |
Implements
CreateSendInterface()
Creates the send interface
Declaration
public NetworkSendInterface CreateSendInterface()Returns
| Type | Description |
|---|---|
| NetworkSendInterface | The network send interface |
Implements
Dispose()
Cleans up both the local end point and the IPCManager instance.
Declaration
public void Dispose()Implements
GetGenericEndPoint(NetworkInterfaceEndPoint)
Retrieves an already created endpoint with port or creates one.
Declaration
public NetworkEndPoint GetGenericEndPoint(NetworkInterfaceEndPoint endpoint)Parameters
| Type | Name | Description |
|---|---|---|
| NetworkInterfaceEndPoint | endpoint | The loopback endpoint |
Returns
| Type | Description |
|---|---|
| NetworkEndPoint | NetworkEndPoint |
Implements
Initialize(NetworkSettings)
Initializes the interface passing in optional INetworkParameter
Declaration
public int Initialize(NetworkSettings settings)Parameters
| Type | Name | Description |
|---|---|---|
| NetworkSettings | settings | NetworkSettings with which to configure the interface. |
Returns
| Type | Description |
|---|---|
| Int32 | Returns 0 on success. |
Implements
Listen()
Start listening for incoming connections. This is normally a no-op for real UDP sockets.
Declaration
public int Listen()Returns
| Type | Description |
|---|---|
| Int32 | 0 on Success |
Implements
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
| 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. |
Implements
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
| 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. |