Class RelayServerEndpoint
The endpoint connection details of a Relay server.
Inheritance
Inherited Members
Namespace: Unity.Services.Relay.Models
Syntax
public class RelayServerEndpointConstructors
RelayServerEndpoint(String, RelayServerEndpoint.NetworkOptions, Boolean, Boolean, String, Int32)
The endpoint connection details of a Relay server.
Declaration
public RelayServerEndpoint(string connectionType, RelayServerEndpoint.NetworkOptions network, bool reliable, bool secure, string host, int port)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | connectionType | Canonical connection type: - udp: Use for plain UDP connections. - dtls: Use for secured UDP connections. See DTLS encryption to learn more. - wss: Use for secured WebSocket connections. |
| RelayServerEndpoint.NetworkOptions | network | The IP network. |
| System.Boolean | reliable | A boolean value indicating whether the delivery of the data is guaranteed. |
| System.Boolean | secure | A boolean value indicating whether the endpoint is secured. |
| System.String | host | The host name or IP address of the Relay server. |
| System.Int32 | port | The port number of the Relay server. |
Fields
ConnectionTypeDtls
Valid value of ConnectionType for dtls
Declaration
public const string ConnectionTypeDtls = "dtls"Field Value
| Type | Description |
|---|---|
| System.String |
ConnectionTypeUdp
Valid value of ConnectionType for udp
Declaration
public const string ConnectionTypeUdp = "udp"Field Value
| Type | Description |
|---|---|
| System.String |
ConnectionTypeWss
Valid value of ConnectionType for wss
Declaration
public const string ConnectionTypeWss = "wss"Field Value
| Type | Description |
|---|---|
| System.String |
Properties
ConnectionType
Canonical connection type: - udp: Use for plain UDP connections. - dtls: Use for secured UDP connections. See DTLS encryption to learn more. - wss: Use for secured WebSocket connections.
Declaration
public string ConnectionType { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Host
The host name or IP address of the Relay server.
Declaration
public string Host { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Network
The IP network.
Declaration
public RelayServerEndpoint.NetworkOptions Network { get; }Property Value
| Type | Description |
|---|---|
| RelayServerEndpoint.NetworkOptions |
Port
The port number of the Relay server.
Declaration
public int Port { get; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
Reliable
A boolean value indicating whether the delivery of the data is guaranteed.
Declaration
public bool Reliable { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Secure
A boolean value indicating whether the endpoint is secured.
Declaration
public bool Secure { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |