Skip to main content

Unity.Networking.Transport.NetworkSettings

A list of the parameters that describe the network configuration.

Implements#

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 NetworkSettings : IDisposable

NetworkSettings(Allocator)#

Creates a new NetworkSettings object using the provided allocator. If no Allocator is provided, Allocator.Temp will be used.

Declaration#

public NetworkSettings(Allocator allocator)

Parameters#

TypeNameDescription
AllocatorallocatorThe allocator used for the parameters list. When Allocator.Temp is used, the settings are valid to use only during one frame.

#

AddRawParameterStruct\<T>(ref T)#

Adds a new parameter to the list. There must be only one instance per parameter type.

Declaration#

public void AddRawParameterStruct<T>(ref T parameter)
where T : struct, INetworkParameter

Parameters#

TypeNameDescription
TparameterThe parameter to add.

Type Parameters#

NameDescription
TThe type of INetworkParameter to add.

Exceptions#

TypeCondition
System.ArgumentExceptionThrows an argument exception if the paramter type is already in the list or if it contains invalid values.

Dispose()#

Declaration#

public void Dispose()

TryGet\<T>(out T)#

Try to get the parameter values for the specified type.

Declaration#

public bool TryGet<T>(out T parameter)
where T : struct, INetworkParameter

Parameters#

TypeNameDescription
TparameterThe stored parameter values.

Returns#

TypeDescription
System.BooleanReturns true if the parameter is in the paramaters list.

Type Parameters#

NameDescription
TThe type of the parameters to get.

Implements#

System.IDisposable

Extension Methods#

BaselibNetworkParameterExtensions.WithBaselibNetworkInterfaceParameters(ref NetworkSettings, Int32, Int32, UInt32)

BaselibNetworkParameterExtensions.GetBaselibNetworkInterfaceParameters(ref NetworkSettings)

CommonNetworkParametersExtensions.WithDataStreamParameters(ref NetworkSettings, Int32)

CommonNetworkParametersExtensions.GetDataStreamParameters(ref NetworkSettings)

CommonNetworkParametersExtensions.WithNetworkConfigParameters(ref NetworkSettings, Int32, Int32, Int32, Int32, Int32, Int32, Int32)

CommonNetworkParametersExtensions.GetNetworkConfigParameters(ref NetworkSettings)

NetworkPipelineParametersExtensions.WithPipelineParameters(ref NetworkSettings, Int32)

NetworkPipelineParametersExtensions.GetPipelineParameters(ref NetworkSettings)

FragmentationStageParameterExtensions.WithFragmentationStageParameters(ref NetworkSettings, Int32)

FragmentationStageParameterExtensions.GetFragmentationStageParameters(ref NetworkSettings)

ReliableStageParameterExtensions.WithReliableStageParameters(ref NetworkSettings, Int32)

ReliableStageParameterExtensions.GetReliableStageParameters(ref NetworkSettings)

SimulatorStageParameterExtensions.WithSimulatorStageParameters(ref NetworkSettings, Int32, Int32, ApplyMode, Int32, Int32, Int32, Int32, Int32, Int32, Int32, UInt32)

SimulatorStageParameterExtensions.GetSimulatorStageParameters(ref NetworkSettings)

RelayParameterExtensions.WithRelayParameters(ref NetworkSettings, ref RelayServerData, Int32)

RelayParameterExtensions.GetRelayParameters(ref NetworkSettings)