Error Codes¶
Most network functions make use of both a success and failure callback. Failure callbacks return useful information to determine the reason a function failed.
Failure callbacks contain an error code and a Strix Error Category Enum. The below lists explain each code:
EStrixErrorCategory::StrixNet¶
Networking errors
Error Code |
Name |
Description |
0 |
STRIX_NET_ERROR_SUCCESS |
General Success |
1 |
STRIX_NET_ERROR_FAILURE |
General Failure |
1000 |
STRIX_NET_ERROR_CHANNEL_RESOLVE_ADDRESS_FAILED |
Failed to resolve a network address during channel connect |
1001 |
STRIX_NET_ERROR_CHANNEL_CONNECT_FAILED |
Failed to connect to a channel |
1002 |
STRIX_NET_ERROR_CHANNEL_SERVER_LISTEN_FAILED |
Server socket failed to listen for a connection |
1003 |
STRIX_NET_ERROR_CHANNEL_SERVER_ACCEPT_FAILED |
Server socket failed to accept a connection attempt |
1004 |
STRIX_NET_ERROR_CHANNEL_CONNECTION_CLOSED |
Channel connection was closed |
1005 |
STRIX_NET_ERROR_CHANNEL_CONNECTION_TIMEOUT |
Channel connection timed out |
1006 |
STRIX_NET_ERROR_CHANNEL_RECEIVE_ERROR |
Error when receiving data on a channel |
1007 |
STRIX_NET_ERROR_CHANNEL_SEND_ERROR |
Error when sending data on a channel |
1008 |
STRIX_NET_ERROR_CHANNEL_INSUFFICIENT_BUFFER |
Error when channel buffer is not large enough for incoming data |
1009 |
STRIX_NET_ERROR_CHANNEL_BAD_FORMAT |
Error when incoming data is badly formatted |
1100 |
STRIX_NET_ERROR_SSL_ERROR |
SSL error |
1101 |
STRIX_NET_ERROR_SSL_HANDSHAKE_TIMEOUT |
The SSL handshake timed out |
1200 |
STRIX_NET_ERROR_LICENSE_VERIFICATION_FAILED |
Verification of the Strix license failed |
EStrixErrorCategory::StrixClient¶
Client logic errors
Standard Errors
Error Code |
Name |
Description |
0 |
UnknownError |
An unknown error occurred |
1 |
InternalError |
An internal error occurred |
2 |
PermissionDenied |
Permission is denied for the attempted action |
3 |
LockFailed |
A resource lock failed |
4 |
LockTimeout |
Timeout while attempting a lock on a resource |
5 |
InstantiationFailed |
Failed to instantiate an object |
6 |
NoSuchProperty |
The property being accessed does not exist |
7 |
InvalidPropertySetting |
The property setting is invalid |
8 |
IncorrectMessageType |
Received an incorrect message type |
9 |
RequestTimeout |
A timeout was reached on a request |
10 |
ModelNotFound |
The requested model was not found |
Authentication Errors
Error Code |
Name |
Description |
1000 |
DuplicateConnectionForSameUid |
Attempting to connect to the same connection with the same unique identifier |
1001 |
CouldNotCalculateHash |
Could not calculate SHA hash |
1002 |
InvalidCredentialsType |
Authorization credentials are of the wrong type |
1003 |
InvalidCredentialsValue |
Authorization credentials are invalid |
1004 |
WrongCredentials |
Authorization credentials do not match authorized credentials |
1005 |
DuplicateUid |
Attempting to use a duplicate UID |
1006 |
UnsupportedLibraryVersion |
The library version you are using is unsupported |
1007 |
InvalidApplicationIdToken |
The application ID token used is invalid |
1008 |
ApplicationIdRequired |
Connection requires an application ID |
1009 |
UserNotFound |
The requested user could not be found |
1010 |
InvalidDigest |
Invalid hash |
1011 |
InvalidNonce |
Invalid nonce |
1012 |
NonceExpired |
The nonce value is out of date |
1013 |
NonceGenerationFailed |
Failed to generate a nonce value |
1014 |
RegisterFailed |
Failed to register a client |
1015 |
TokenAuthorizationRequired |
Requires token authorization |
1016 |
AuthorizationNotEnabled |
Attempting to perform authentication when it is not enabled |
Session Errors
Error Code |
Name |
Description |
2000 |
InvalidSessionToken |
The token for this session is invalid |
2001 |
SessionNotFound |
The session could not be found |
Messenger Errors
Error Code |
Name |
Description |
3000 |
SendingToSelfUidNotAllowed |
Attempting to send to yourself |
Node Errors
Error Code |
Name |
Description |
4000 |
NoNodesAvailable |
There are no nodes available to connect |
4001 |
NodeAlreadyExists |
Attempting to create node when it already exists |
Room Errors
Error Code |
Name |
Description |
5000 |
MessageLimitReached |
Too many messages per second for this room |
5001 |
NotRoomMember |
Attempting to operate on a room member that is not in this room |
5002 |
NotRoomOwner |
This room member is not the Room Owner |
5003 |
RoomFullOfMembers |
Room is full |
5004 |
RoomNotFound |
The room could not be found |
5005 |
RoomMemberNotFound |
The room member could not be found |
5006 |
NotAllowedForOtherRoomMember |
Cannot perform this operation on another room member |
5007 |
AlreadyInRoom |
Trying to connect to a room while already connected |
5008 |
WrongRoomPassword |
Incorrect password for this room |
5009 |
RoomNotJoinable |
Attempting to join a room that cannot be joined |
5010 |
NoRoomsAvailable |
No rooms available |
5011 |
MaxRoomCountReached |
Cannot create anymore rooms on this server |
Replica Errors
Error Code |
Name |
Description |
6000 |
NotReplicaOwner |
Cannot perform this operation if not the owner of this replica |
6001 |
NotRoomMember |
Cannot perform this operation if not a room member |
6002 |
NotRoomOwner |
Cannot perform this operation if not a Room Owner |
6003 |
WrongPropertyMapFormat |
Incorrect formatting of the property map for this replica |
EStrixErrorCategory::StrixUESDK¶
Errors specific to the SDK
Error Code |
Name |
Description |
1 |
MasterServerAlreadyConnected |
Trying to connect to master when already connected |
2 |
MasterServerNotConnected |
Trying a Master Server operation when the server is not connected |
101 |
RoomServerAlreadyConnected |
Trying to connect to a Room Server when already connected |
102 |
RoomServerNotConnected |
Trying a Room Server operation when the server is not connected |
201 |
RoomContextAlreadyExists |
Trying to connect to a room when already connected |
202 |
RoomContextDoesNotExist |
Trying a room operation without a room context |
EStrixErrorCategory::External¶
Errors outside of Strix