Enum RelayExceptionReason

Enumerates the known error causes when communicating with the Relay Service.

Namespace: Unity.Services.Relay

Assembly: Unity.Services.Multiplayer.dll

Syntax

public enum RelayExceptionReason

Fields

Name	Description
AllocationNotFound	AllocationNotFound is returned when the allocation is not found possibly due to a timeout. To prevent such an unintended timeout, the game client should send periodic ping messages to the Relay server over UDP to keep the connection alive.
BadGateway	Same as the HTTP Status.
Conflict	Same as the HTTP Status.
EntityNotFound	The requested entity (allocation, join code or region) does not exist.
ExpectationFailed	Same as the HTTP Status.
FailedDependency	Same as the HTTP Status.
Forbidden	The user does not have permission to access the requested resource.
GatewayTimeout	Same as the HTTP Status.
Gone	The requested resource has been permenantly deleted from the server.
HttpVersionNotSupported	Same as the HTTP Status.
InactiveProject	InactiveProject is returned when the Unity project is inactive or not found. Make sure it is active and assigned to your project and you enabled the Relay Service using the Unity Dashboard for that project.
InsufficientStorage	Same as the HTTP Status.
InternalServerError	The Relay Service has encountered a situation it doesn't know how to handle.
InvalidArgument	The Relay Service could not understand the request due to an invalid value or syntax.
InvalidRequest	InvalidRequest is returned when the request is not in a valid format.
JoinCodeNotFound	JoinCodeNotFound is returned when the join code is not found. Try getting a new join code.
LengthRequired	Same as the HTTP Status.
Locked	Same as the HTTP Status.
LoopDetected	Same as the HTTP Status.
Max	End of the range of error codes addressable by the Relay Allocations Service.
MethodNotAllowed	Same as the HTTP Status.
Min	Start of the range of error codes addressable by the Relay Allocations Service.
Misdirected	Same as the HTTP Status.
NetworkAuthenticationRequired	Same as the HTTP Status.
NetworkError	NetworkError is returned when the Allocation is unable to connect to the service due to a network error like when TLS Negotiation fails.
NoError	Default value of the enum. No error detected.
NoSuitableRelay	RelaySelectionFailed is returned when no suitable relay could be selected during allocation. Try again later.
NotAcceptable	Same as the HTTP Status.
NotExtended	Same as the HTTP Status.
NotImplemented	Same as the HTTP Status.
PaymentRequired	Same as the HTTP Status.
PreconditionFailed	Same as the HTTP Status.
PreconditionRequired	Same as the HTTP Status.
ProxyAuthenticationRequired	Same as the HTTP Status.
RangeNotSatisfiable	Same as the HTTP Status.
RateLimited	The user has sent too many requests in a given amount of time and is now rate limited.
RegionNotFound	RegionNotFound is returned when the region is not found in the current catalog.
RequestEntityTooLarge	Same as the HTTP Status.
RequestHeaderFieldsTooLarge	Same as the HTTP Status.
RequestTimeOut	Same as the HTTP Status.
RequestUriTooLong	Same as the HTTP Status.
ServiceUnavailable	The Relay Service is not ready to handle the request. Common causes are a server that is down for maintenance or that is overloaded. Try again later.
Teapot	Same as the HTTP Status.
TooEarly	Same as the HTTP Status.
Unauthorized	The Relay Service could not determine the user identity.
UnavailableForLegalReasons	Same as the HTTP Status.
Unknown	Unknown is returned when a unrecognized error code is returned by the service. Check the inner exception to get more information.
UnprocessableTransaction	Same as the HTTP Status.
UnsupportedMediaType	Same as the HTTP Status.
UpgradeRequired	Same as the HTTP Status.
VariantAlsoNegotiates	Same as the HTTP Status.