Struct RelayNetworkParameter

Parameters for the Unity Relay connection.

Inherited Members

ValueType.Equals(Object)

ValueType.GetHashCode()

ValueType.ToString()

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetType()

Namespace: Unity.Networking.Transport.Relay

Syntax

public struct RelayNetworkParameter : INetworkParameter

Fields

RelayConnectionTimeMS

Frequency at which the relay server will be pinged to maintain the connection alive. Should be set to less than 10 seconds (default is 3 seconds) since that's the time after which the relay server will sever the connection if there is no activity.

Declaration

public int RelayConnectionTimeMS

Field Value

Type	Description
Int32	Frequency in milliseconds.

ServerData

Connection information about the relay server.

Declaration

public RelayServerData ServerData

Field Value

Type	Description
RelayServerData	Server data structure.

Methods

Validate()

Checks if the values for all fields are valid. This method will be automatically called when adding parameters to the NetworkSettings.

Declaration

public bool Validate()

Returns

Type	Description
Boolean	True if the parameter is valid, false otherwise.

Implements

INetworkParameter.Validate()