CYB::Exception::Internal Class Reference

Exceptions that are thrown internally in the engine that the should never see, these are a superset of SystemData type exceptions. If one of these exceptions appear in a unit, please contant the engine development team. More...

#include <Exception.hpp>

Inheritance diagram for CYB::Exception::Internal:

Collaboration diagram for CYB::Exception::Internal:

Public Types
enum	ErrorCode : unsigned int {   MEMORY_COMMITAL_FAILURE, MEMORY_PROTECT_FAILURE, MEMORY_RESERVATION_FAILURE, MODULE_FUNCTION_LOAD_FAILURE,   MODULE_LOAD_FAILURE, PATH_EVALUATION_FAILURE, PROCESS_CREATION_ERROR, PROCESS_EXIT_CODE_UNCHECKABLE,   PROCESS_TERMINATION_ERROR }
	The error code of the exception. More...
Public Types inherited from CYB::Exception::Base
enum	Level : byte { Level::VIOLATION, Level::SYSTEM_DATA, Level::INTERNAL, Level::UNIT }
	The extended type of the exception. More...

Public Member Functions
	Internal (const ErrorCode AErrorCode) noexcept
	Construct an Internal exception. More...

Static Private Member Functions
static API::String::Static	ErrorMessage (const ErrorCode AErrorCode) noexcept
	Get the associated message for an exception. More...

Additional Inherited Members
Public Attributes inherited from CYB::Exception::Base
API::String::Static	FMessage
	An english description of the error, guaranteed to be compatible with CYB::API::String::UTF8.
const unsigned int	FErrorCode
	The assigned error code.
const Level	FLevel
	The type of the exception.
Protected Member Functions inherited from CYB::Exception::Base
	Base (API::String::Static &&AMessage, const unsigned int AErrorCode, const Level ALevel) noexcept
	Construct a Base exception. More...

Detailed Description

Exceptions that are thrown internally in the engine that the should never see, these are a superset of SystemData type exceptions. If one of these exceptions appear in a unit, please contant the engine development team.

Definition at line 104 of file Exception.hpp.

Member Enumeration Documentation

enum CYB::Exception::Internal::ErrorCode : unsigned int

The error code of the exception.

Enumerator
MEMORY_COMMITAL_FAILURE	Memory could not be commited from a reservation.
MEMORY_PROTECT_FAILURE	Memory protection could not be set.
MEMORY_RESERVATION_FAILURE	Memory could not be reserved.
MODULE_FUNCTION_LOAD_FAILURE	Specific could not be loaded from given Module.
MODULE_LOAD_FAILURE	Module could not be loaded.
PATH_EVALUATION_FAILURE	Failed to evaluate a Path.
PROCESS_CREATION_ERROR	Process could not be created for unknown reasons.
PROCESS_EXIT_CODE_UNCHECKABLE	Tried to check the error code of a Process the OS would not allow.
PROCESS_TERMINATION_ERROR	Process could not be terminated, most likely due to insufficient priviledges.

Definition at line 107 of file Exception.hpp.

                           : unsigned int {
                MEMORY_COMMITAL_FAILURE, 
                MEMORY_PROTECT_FAILURE, 
                MEMORY_RESERVATION_FAILURE, 
                MODULE_FUNCTION_LOAD_FAILURE, 
                MODULE_LOAD_FAILURE, 
                PATH_EVALUATION_FAILURE, 
                PROCESS_CREATION_ERROR, 
                PROCESS_EXIT_CODE_UNCHECKABLE, 
                PROCESS_TERMINATION_ERROR, 
            };

Constructor & Destructor Documentation

CYB::Exception::Internal::Internal ( const ErrorCode  AErrorCode )

noexcept

Construct an Internal exception.

Parameters

AErrorCode

The ErrorCode describing the exception

Thread Safety

This function requires no thread safety

Exceptions

CYB::Exception::Violation

Error code: CYB::Exception::Violation::INVALID_EXCEPTION_CODE. Thrown if AErrorCode is not recognized by the engine

Attention

This function is for internal use only

Definition at line 126 of file CYBException.cpp.

                                                                  :
    Base(ErrorMessage(AErrorCode), AErrorCode, Level::INTERNAL)
{
    FLastInstantiatedExceptionCode = AErrorCode;
}

Member Function Documentation

CYB::API::String::Static CYB::Exception::Internal::ErrorMessage ( const ErrorCode  AErrorCode )

staticprivatenoexcept

Get the associated message for an exception.

Parameters

AErrorCode

The ErrorCode describing the exception

Returns

A description of the exception indicated by AErrorCode

Thread Safety

This function requires no thread safety

Definition at line 91 of file CYBException.cpp.

                                                                                         {
    API::Assert::LessThanOrEqual(AErrorCode, PROCESS_TERMINATION_ERROR);
    API::String::Static ErrorMessage;
    switch (AErrorCode) {
    case MEMORY_COMMITAL_FAILURE:
        ErrorMessage = API::String::Static(u8"Failed to commit virtual memory from the OS.");
        break;
    case MEMORY_PROTECT_FAILURE:
        ErrorMessage = API::String::Static(u8"Failed to implement requested virtual memory protection level.");
        break;
    case MEMORY_RESERVATION_FAILURE:
        ErrorMessage = API::String::Static(u8"Failed to reserve virtual memory from the OS.");
        break;
    case MODULE_FUNCTION_LOAD_FAILURE:
        ErrorMessage = API::String::Static(u8"Failed to load a requested function from a module.");
        break;
    case MODULE_LOAD_FAILURE:
        ErrorMessage = API::String::Static(u8"Failed to load a requested module.");
        break;
    case PATH_EVALUATION_FAILURE:
        ErrorMessage = API::String::Static(u8"Failed to evaluate a Path.");
        break;
    case PROCESS_CREATION_ERROR:
        ErrorMessage = API::String::Static(u8"Failed to create Process for unknown reasons.");
        break;
    case PROCESS_EXIT_CODE_UNCHECKABLE:
        ErrorMessage = API::String::Static(u8"Tried to check the error code of a Process the OS would not allow.");
        break;
    case PROCESS_TERMINATION_ERROR:
        ErrorMessage = API::String::Static(u8"Failed to terminate process, most likely due to insufficient permissions.");
        break;
    };
    return ErrorMessage;
}

---

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

• Engine/API/Types/Exception.hpp
• Engine/Engine/Core/CYBException.cpp

---

Generated by   1.8.6