Exit codes used by OpenTwin applications. More...

#include "AppExitCodes.h"

Public Types
enum	FrameworkExitCode : int { GeneralFrameworkError = 100 }
	Framework exit codes (100 - 999). Exit codes used by the OpenTwin framework. These codes are used to indicate specific errors or conditions that occur within the framework itself. They are not intended for use by individual applications or modules. More...

enum	IOExitCode : int { GeneralIOError = 1000 , FileNotFound = 1001 , InvalidFileFormat = 1002 , PermissionDenied = 1003 , OutOfMemory = 1004 , InvalidPath = 1005 , SendFailed = 1006 }
	IO exit codes (1000 - 1099). IO exit codes are used to indicate specific errors or conditions that occur during input/output operations (e.g. while sending a request or reading a file). More...

enum	ServiceDataExitCode : int { GeneralServiceDataError = 1100 , ServiceUrlMissing = 1101 , ServiceUrlInvalid = 1102 , AuthUrlMissing = 1111 , AuthUrlInvalid = 1112 , GSSUrlMissing = 1121 , GSSUrlInvalid = 1122 , LSSUrlMissing = 1131 , LSSUrlInvalid = 1132 , GDSUrlMissing = 1141 , GDSUrlInvalid = 1142 , LDSUrlMissing = 1151 , LDSUrlInvalid = 1152 }
	Service data exit codes (1100 - 1199). Exit codes generated related to service data conflicts/errors. More...

enum	ServiceStateExitCode : int { GeneralServiceStateError = 1200 , AuthRegistrationFailed = 1201 , GSSRegistrationFailed = 1202 , LSSRegistrationFailed = 1203 , GDSRegistrationFailed = 1204 , LDSRegistrationFailed = 1205 , AuthNotRunning = 1206 , GSSNotRunning = 1207 , LSSNotRunning = 1208 , GDSNotRunning = 1209 , LDSNotRunning = 1210 }
	Service state exit codes (1200 - 1299). Exit codes generated related to service state errors. More...

enum	DataBaseExitCode : int { GeneralDataBaseError = 1800 , DataBaseUrlMissing = 1801 , DataBaseUrlInvalid = 1802 , DataBaseConnectionFailed = 1803 , DataBaseInvalidCredentials = 1804 }
	Data Base related exit codes (1800 - 1899). More...

enum	GeneralExitCode : int { Success = 0 , GeneralError = 7700 , UnknownError = 7701 , EmergencyShutdown = 7702 , EnvironmentError = 7703 , ConfigurationBroken = 7704 , OpenGLError = 7705 , AssetError = 7706 , ComponentError = 7707 , LogInError = 7800 , FailedToConvertPort = 7801 , KeepAliveFailed = 7802 , InitializationTimeout = 7803 }
	General exit codes (7700+). Contains all general and uncategorized exit codes. More...

Static Public Member Functions
static std::string	toString (int _exitCode)
	Returns a humanly readable string representation of the given exit code.

Detailed Description

Exit codes used by OpenTwin applications.

Member Enumeration Documentation

◆ DataBaseExitCode

enum ot::AppExitCode::DataBaseExitCode : int

Data Base related exit codes (1800 - 1899).

Enumerator
GeneralDataBaseError
DataBaseUrlMissing	General database error.
DataBaseUrlInvalid	Database URL is missing.
DataBaseConnectionFailed	Database URL is invalid.
DataBaseInvalidCredentials	Database connection failed.

◆ FrameworkExitCode

enum ot::AppExitCode::FrameworkExitCode : int

Framework exit codes (100 - 999). Exit codes used by the OpenTwin framework. These codes are used to indicate specific errors or conditions that occur within the framework itself. They are not intended for use by individual applications or modules.

Enumerator
GeneralFrameworkError

◆ GeneralExitCode

enum ot::AppExitCode::GeneralExitCode : int

General exit codes (7700+). Contains all general and uncategorized exit codes.

Enumerator
Success
GeneralError	General success exit code.
UnknownError	General error exit code.
EmergencyShutdown	Unknown error exit code.
EnvironmentError	Emergency shutdown exit code.
ConfigurationBroken	Environment error exit code.
OpenGLError	Configuration broken exit code.
AssetError	OpenGL error exit code.
ComponentError	Asset error exit code.
LogInError	Component error exit code.
FailedToConvertPort	Log in error exit code.
KeepAliveFailed	Failed to convert port exit code.
InitializationTimeout	Keep alive failed exit code.

◆ IOExitCode

enum ot::AppExitCode::IOExitCode : int

IO exit codes (1000 - 1099). IO exit codes are used to indicate specific errors or conditions that occur during input/output operations (e.g. while sending a request or reading a file).

Enumerator
GeneralIOError
FileNotFound	General IO error.
InvalidFileFormat	File not found error.
PermissionDenied	Invalid file format error.
OutOfMemory	Permission denied error.
InvalidPath	Out of memory error.
SendFailed	Invalid path error.

◆ ServiceDataExitCode

enum ot::AppExitCode::ServiceDataExitCode : int

Service data exit codes (1100 - 1199). Exit codes generated related to service data conflicts/errors.

Enumerator
GeneralServiceDataError
ServiceUrlMissing	General service data error.
ServiceUrlInvalid	Service URL is missing.
AuthUrlMissing	Service URL is invalid.
AuthUrlInvalid	Authentication URL is missing.
GSSUrlMissing	Authentication URL is invalid.
GSSUrlInvalid	Global Session Service URL is missing.
LSSUrlMissing	Global Session Service URL is invalid.
LSSUrlInvalid	Local Session Service URL is missing.
GDSUrlMissing	Local Session Service URL is invalid.
GDSUrlInvalid	Global Directory Service URL is missing.
LDSUrlMissing	Global Directory Service URL is invalid.
LDSUrlInvalid	Local Directory Service URL is missing.

◆ ServiceStateExitCode

enum ot::AppExitCode::ServiceStateExitCode : int

Service state exit codes (1200 - 1299). Exit codes generated related to service state errors.

Enumerator
GeneralServiceStateError
AuthRegistrationFailed	General service state error.
GSSRegistrationFailed	Authentication Service registration failed.
LSSRegistrationFailed	Global Session Service registration failed.
GDSRegistrationFailed	Local Session Service registration failed.
LDSRegistrationFailed	Global Directory Service registration failed.
AuthNotRunning	Local Directory Service registration failed.
GSSNotRunning	Authentication Service is not running.
LSSNotRunning	Global Session Service is not running.
GDSNotRunning	Local Session Service is not running.
LDSNotRunning	Global Directory Service is not running.

Member Function Documentation

◆ toString()

std::string ot::AppExitCode::toString ( int _exitCode )

static

Returns a humanly readable string representation of the given exit code.

References AssetError, AuthNotRunning, AuthRegistrationFailed, AuthUrlInvalid, AuthUrlMissing, ComponentError, ConfigurationBroken, DataBaseConnectionFailed, DataBaseInvalidCredentials, DataBaseUrlInvalid, DataBaseUrlMissing, EmergencyShutdown, EnvironmentError, FailedToConvertPort, FileNotFound, GDSNotRunning, GDSRegistrationFailed, GDSUrlInvalid, GDSUrlMissing, GeneralDataBaseError, GeneralError, GeneralFrameworkError, GeneralIOError, GeneralServiceDataError, GeneralServiceStateError, GSSNotRunning, GSSRegistrationFailed, GSSUrlInvalid, GSSUrlMissing, InitializationTimeout, InvalidFileFormat, InvalidPath, KeepAliveFailed, LDSNotRunning, LDSRegistrationFailed, LDSUrlInvalid, LDSUrlMissing, LogInError, LSSNotRunning, LSSRegistrationFailed, LSSUrlInvalid, LSSUrlMissing, OpenGLError, OutOfMemory, PermissionDenied, SendFailed, ServiceUrlInvalid, ServiceUrlMissing, Success, and UnknownError.

The documentation for this class was generated from the following files:

Libraries/OTSystem/include/OTSystem/AppExitCodes.h
Libraries/OTSystem/src/AppExitCodes.cpp
Services/GlobalSessionService/src/dllmain.cpp
Services/LocalSessionService/src/dllmain.cpp

Public Types

Static Public Member Functions