v1.0.0
Latest
2022.3+

Class ServerConfig

The server configuration for the current session.

Inheritance
System.Object
ServerConfig
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Unity.Services.Multiplay
Syntax
public class ServerConfig

Constructors

ServerConfig(Int64, String, UInt16, UInt16, String, String)

Creates an instance of ServerConfig. Note that you should not manually create one of these except for testing. Instead, use MultiplayService.ServerConfig to access the server configuration.

Declaration
public ServerConfig(long serverId, string allocationId, ushort queryPort, ushort port, string ip, string serverLogDirectory)
Parameters
TypeNameDescription
System.Int64serverId

The Server ID.

System.StringallocationId

The Allocation ID for the server.

System.UInt16queryPort

The Query Port.

System.UInt16port

The Game Session Port.

System.Stringip

The Game Session IP Address.

System.StringserverLogDirectory

The Server Log Directory.

Properties

AllocationId

The allocation ID.

Declaration
public string AllocationId { get; }
Property Value
TypeDescription
System.String

IpAddress

The connection ip for the session.

Declaration
public string IpAddress { get; }
Property Value
TypeDescription
System.String

Port

The connection port for the session.

Declaration
public ushort Port { get; }
Property Value
TypeDescription
System.UInt16

QueryPort

The Server Query Protocol Port.

Declaration
public ushort QueryPort { get; }
Property Value
TypeDescription
System.UInt16

ServerId

The server ID.

Declaration
public long ServerId { get; }
Property Value
TypeDescription
System.Int64

ServerLogDirectory

The directory logs will be written to.

Declaration
public string ServerLogDirectory { get; }
Property Value
TypeDescription
System.String