Struct NetworkDriver

Namespace: Unity.Networking.Transport

Syntax

public struct NetworkDriver : IDisposable

Constructors

NetworkDriver(INetworkInterface, INetworkParameter[])

Constructor for GenericNetworkDriver.

Declaration

public NetworkDriver(INetworkInterface netIf, params INetworkParameter[] param)

Parameters

Type	Name	Description
INetworkInterface	netIf
INetworkParameter[]	param	An array of INetworkParameter. There are currently only two INetworkParameter, the NetworkDataStreamParameter and the NetworkConfigParameter.

Properties

IsCreated

Declaration

public bool IsCreated { get; }

Property Value

Type	Description
Boolean

LastUpdateTime

Declaration

public long LastUpdateTime { get; }

Property Value

Type	Description
Int64

Listening

Declaration

public bool Listening { get; }

Property Value

Type	Description
Boolean

ReceiveErrorCode

Declaration

public int ReceiveErrorCode { get; }

Property Value

Type	Description
Int32

Methods

AbortSend(DataStreamWriter)

Declaration

public void AbortSend(DataStreamWriter writer)

Parameters

Type	Name	Description
DataStreamWriter	writer

Accept()

Declaration

public NetworkConnection Accept()

Returns

Type	Description
NetworkConnection

BeginSend(NetworkConnection, Int32)

Declaration

public DataStreamWriter BeginSend(NetworkConnection id, int requiredPayloadSize = 0)

Parameters

Type	Name	Description
NetworkConnection	id
Int32	requiredPayloadSize

Returns

Type	Description
DataStreamWriter

BeginSend(NetworkPipeline, NetworkConnection, Int32)

Declaration

public DataStreamWriter BeginSend(NetworkPipeline pipe, NetworkConnection id, int requiredPayloadSize = 0)

Parameters

Type	Name	Description
NetworkPipeline	pipe
NetworkConnection	id
Int32	requiredPayloadSize

Returns

Type	Description
DataStreamWriter

Bind(NetworkEndPoint)

Declaration

public int Bind(NetworkEndPoint endpoint)

Parameters

Type	Name	Description
NetworkEndPoint	endpoint

Returns

Type	Description
Int32

Connect(NetworkEndPoint)

Declaration

public NetworkConnection Connect(NetworkEndPoint endpoint)

Parameters

Type	Name	Description
NetworkEndPoint	endpoint

Returns

Type	Description
NetworkConnection

Create(INetworkParameter[])

Declaration

public static NetworkDriver Create(params INetworkParameter[] param)

Parameters

Type	Name	Description
INetworkParameter[]	param

Returns

Type	Description
NetworkDriver

CreatePipeline(Type[])

Declaration

public NetworkPipeline CreatePipeline(params Type[] stages)

Parameters

Type	Name	Description
Type[]	stages

Returns

Type	Description
NetworkPipeline

Disconnect(NetworkConnection)

Declaration

public int Disconnect(NetworkConnection id)

Parameters

Type	Name	Description
NetworkConnection	id

Returns

Type	Description
Int32

Dispose()

Declaration

public void Dispose()

EndSend(DataStreamWriter)

Declaration

public int EndSend(DataStreamWriter writer)

Parameters

Type	Name	Description
DataStreamWriter	writer

Returns

Type	Description
Int32

GetConnectionState(NetworkConnection)

Declaration

public NetworkConnection.State GetConnectionState(NetworkConnection con)

Parameters

Type	Name	Description
NetworkConnection	con

Returns

Type	Description
NetworkConnection.State

GetEventQueueSizeForConnection(NetworkConnection)

Declaration

public int GetEventQueueSizeForConnection(NetworkConnection connectionId)

Parameters

Type	Name	Description
NetworkConnection	connectionId

Returns

Type	Description
Int32

GetPipelineBuffers(NetworkPipeline, NetworkPipelineStageId, NetworkConnection, out NativeArray<Byte>, out NativeArray<Byte>, out NativeArray<Byte>)

Declaration

public void GetPipelineBuffers(NetworkPipeline pipeline, NetworkPipelineStageId stageId, NetworkConnection connection, out NativeArray<byte> readProcessingBuffer, out NativeArray<byte> writeProcessingBuffer, out NativeArray<byte> sharedBuffer)

Parameters

Type	Name	Description
NetworkPipeline	pipeline
NetworkPipelineStageId	stageId
NetworkConnection	connection
NativeArray<Byte>	readProcessingBuffer
NativeArray<Byte>	writeProcessingBuffer
NativeArray<Byte>	sharedBuffer

Listen()

Declaration

public int Listen()

Returns

Type	Description
Int32

LocalEndPoint()

Declaration

public NetworkEndPoint LocalEndPoint()

Returns

Type	Description
NetworkEndPoint

MaxHeaderSize(NetworkPipeline)

Declaration

public int MaxHeaderSize(NetworkPipeline pipe)

Parameters

Type	Name	Description
NetworkPipeline	pipe

Returns

Type	Description
Int32

PopEvent(out NetworkConnection, out DataStreamReader)

Declaration

public NetworkEvent.Type PopEvent(out NetworkConnection con, out DataStreamReader reader)

Parameters

Type	Name	Description
NetworkConnection	con
DataStreamReader	reader

Returns

Type	Description
NetworkEvent.Type

PopEventForConnection(NetworkConnection, out DataStreamReader)

Declaration

public NetworkEvent.Type PopEventForConnection(NetworkConnection connectionId, out DataStreamReader reader)

Parameters

Type	Name	Description
NetworkConnection	connectionId
DataStreamReader	reader

Returns

Type	Description
NetworkEvent.Type

RemoteEndPoint(NetworkConnection)

Declaration

public NetworkEndPoint RemoteEndPoint(NetworkConnection id)

Parameters

Type	Name	Description
NetworkConnection	id

Returns

Type	Description
NetworkEndPoint

ScheduleFlushSend(JobHandle)

Declaration

public JobHandle ScheduleFlushSend(JobHandle dep)

Parameters

Type	Name	Description
JobHandle	dep

Returns

Type	Description
JobHandle

ScheduleUpdate(JobHandle)

Declaration

public JobHandle ScheduleUpdate(JobHandle dep = default(JobHandle))

Parameters

Type	Name	Description
JobHandle	dep

Returns

Type	Description
JobHandle

ToConcurrent()

Create a Concurrent Copy of the NetworkDriver.

Declaration

public NetworkDriver.Concurrent ToConcurrent()

Returns

Type	Description
NetworkDriver.Concurrent