Struct SimulatorPipelineStage

This pipeline stage can be used to add artificial network conditions (packet loss, latency, etc.) to the traffic going through it. This is useful to test a game under conditions closer to what can be observed in real networks.

Implements

INetworkPipelineStage

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: Unity.Networking.Transport

Assembly: Unity.Networking.Transport.dll

Syntax

[BurstCompile]
public struct SimulatorPipelineStage : INetworkPipelineStage

Properties

StaticSize

Amount of data that the pipeline stage requires in "static" storage (storage shared by all instances of the pipeline stage). For example, this is often used to store configuration parameters obtained through NetworkSettings.

Declaration

public int StaticSize { get; }

Property Value

Type	Description
int	Size in bytes.

Methods

StaticInitialize(byte*, int, NetworkSettings)

Initialize the static storage for the pipeline from the settings. More importantly, this method is responsible for providing the NetworkPipelineStage structure, which contains function pointers for most of the pipeline stage functionality.

Declaration

public NetworkPipelineStage StaticInitialize(byte* staticInstanceBuffer, int staticInstanceBufferLength, NetworkSettings settings)

Parameters

Type	Name	Description
byte*	staticInstanceBuffer	Static storage pointer.
int	staticInstanceBufferLength	Static storage length.
NetworkSettings	settings	Settings provided to the driver.

Returns

Type	Description
NetworkPipelineStage	Runtime information for a pipeline instance.

Implements

INetworkPipelineStage