Struct NetworkMetricsPipelineStage

A pipeline stage that tracks some internal metrics that are then used by the multiplayer tools package. This should only be used when creating a custom Unity.Networking.Transport.NetworkDriver with INetworkStreamDriverConstructor if compatibility with the multiplayer tools package is desired. In that situation, this stage needs to be registered with the constructed driver with Unity.Networking.Transport.NetworkDriver.RegisterPipelineStage<T>(T).

Implements

INetworkPipelineStage

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: Unity.Netcode.Transports.UTP

Assembly: Unity.Netcode.Runtime.dll

Syntax

[BurstCompile]
public struct NetworkMetricsPipelineStage : 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 Unity.Networking.Transport.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 Unity.Networking.Transport.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

Unity.Networking.Transport.INetworkPipelineStage