Class Allocation#

The details of an allocation to a Relay server.

Namespace: Unity.Services.Relay.Models#

Syntax#

[Preserve]
public class Allocation

Constructors#

Allocation(Guid, List<RelayServerEndpoint>, RelayServer, Byte[], Byte[], Byte[], String)#

The details of an allocation to a Relay server.

Declaration#

[Preserve]
public Allocation(Guid allocationId, List<RelayServerEndpoint> serverEndpoints, RelayServer relayServer, byte[] key, byte[] connectionData, byte[] allocationIdBytes, string region)

Parameters#

Properties#

AllocationId#

The unique ID of the allocation.

Declaration#

[Preserve]
public Guid AllocationId { get; }

Property Value#

AllocationIdBytes#

A base64-encoded form of the allocation ID. When decoded, this is the exact expected byte alignment to use when crafting Relay protocol messages that require the allocation ID. For example, PING, CONNECT, RELAY, and CLOSE message types.

Declaration#

[Preserve]
public byte[] AllocationIdBytes { get; }

Property Value#

ConnectionData#

A base64-encoded representation of an encrypted connection data blob describing this allocation. This data is equired for establishing communication with other players.

Declaration#

[Preserve]
public byte[] ConnectionData { get; }

Property Value#

Key#

A base64-encoded key required for the HMAC signature of the BIND message.

Declaration#

[Preserve]
public byte[] Key { get; }

Property Value#

Region#

The allocation region.

Declaration#

[Preserve]
public string Region { get; }

Property Value#

RelayServer#

Parameter relayServer of Allocation

Declaration#

[Preserve]
public RelayServer RelayServer { get; }

Property Value#

ServerEndpoints#

Connection endpoints for the assigned Relay server. > Note: The order of server endpoints is not guaranteed and users should iterate over the items and look for the desired values.

Declaration#

[Preserve]
public List<RelayServerEndpoint> ServerEndpoints { get; }

Property Value#