GATE
C/C++ Framework
Loading...
Searching...
No Matches
results.h File Reference

Status, result and error code definitions. More...

#include "gate/gate_core_api.h"
#include "gate/gatetypes.h"

Macros

#define GATE_RESULT_ERROR   -32768
#define GATE_RESULT_FAILED   (GATE_RESULT_ERROR + 0x001)
#define GATE_RESULT_CANCELED   (GATE_RESULT_ERROR + 0x002)
#define GATE_RESULT_INVALIDARG   (GATE_RESULT_ERROR + 0x003)
#define GATE_RESULT_ACCESSDENIED   (GATE_RESULT_ERROR + 0x004)
#define GATE_RESULT_PERMISSIONDENIED   (GATE_RESULT_ERROR + 0x005)
#define GATE_RESULT_NOTDEFINED   (GATE_RESULT_ERROR + 0x006)
#define GATE_RESULT_NOTAVAILABLE   (GATE_RESULT_ERROR + 0x007)
#define GATE_RESULT_NOTIMPLEMENTED   (GATE_RESULT_ERROR + 0x008)
#define GATE_RESULT_NOMATCH   (GATE_RESULT_ERROR + 0x009)
#define GATE_RESULT_NOTSUPPORTED   (GATE_RESULT_ERROR + 0x00a)
#define GATE_RESULT_NOTREQUIRED   (GATE_RESULT_ERROR + 0x00b)
#define GATE_RESULT_NOTREADY   (GATE_RESULT_ERROR + 0x00c)
#define GATE_RESULT_SECURITYBREACH   (GATE_RESULT_ERROR + 0x00d)
#define GATE_RESULT_ALREADYEXISTS   (GATE_RESULT_ERROR + 0x00e)
#define GATE_RESULT_INVALIDSTATE   (GATE_RESULT_ERROR + 0x00f)
#define GATE_RESULT_OUTOFMEMORY   (GATE_RESULT_ERROR + 0x021)
#define GATE_RESULT_OUTOFRESOURCES   (GATE_RESULT_ERROR + 0x022)
#define GATE_RESULT_OUTOFBOUNDS   (GATE_RESULT_ERROR + 0x023)
#define GATE_RESULT_NULLPOINTER   (GATE_RESULT_ERROR + 0x024)
#define GATE_RESULT_BADCAST   (GATE_RESULT_ERROR + 0x025)
#define GATE_RESULT_ARITHMETICERROR   (GATE_RESULT_ERROR + 0x026)
#define GATE_RESULT_OVERFLOW   (GATE_RESULT_ERROR + 0x027)
#define GATE_RESULT_UNDERFLOW   (GATE_RESULT_ERROR + 0x028)
#define GATE_RESULT_LOCKED   (GATE_RESULT_ERROR + 0x029)
#define GATE_RESULT_TIMEOUT   (GATE_RESULT_ERROR + 0x02a)
#define GATE_RESULT_BADADDRESS   (GATE_RESULT_ERROR + 0x02b)
#define GATE_RESULT_BLOCKED   (GATE_RESULT_ERROR + 0x02c)
#define GATE_RESULT_DEVICEERROR   (GATE_RESULT_ERROR + 0x02d)
#define GATE_RESULT_EXECUTIONFAILED   (GATE_RESULT_ERROR + 0x031)
#define GATE_RESULT_EXECUTIONINTERRUPTED   (GATE_RESULT_ERROR + 0x032)
#define GATE_RESULT_CRITICALERROR   (GATE_RESULT_ERROR + 0x033)
#define GATE_RESULT_UNKNOWNEXCEPTION   (GATE_RESULT_ERROR + 0x034)
#define GATE_RESULT_PRECONDITIONFAILED   (GATE_RESULT_ERROR + 0x035)
#define GATE_RESULT_PREPARATIONFAILED   (GATE_RESULT_ERROR + 0x036)
#define GATE_RESULT_BADINSTRUCTION   (GATE_RESULT_ERROR + 0x037)
#define GATE_RESULT_INVALIDHEADER   (GATE_RESULT_ERROR + 0x081)
#define GATE_RESULT_INVALIDDATA   (GATE_RESULT_ERROR + 0x082)
#define GATE_RESULT_INVALIDCONTENT   (GATE_RESULT_ERROR + 0x083)
#define GATE_RESULT_INCORRECTSIZE   (GATE_RESULT_ERROR + 0x084)
#define GATE_RESULT_INCORRECTTYPE   (GATE_RESULT_ERROR + 0x085)
#define GATE_RESULT_ENDOFSTREAM   (GATE_RESULT_ERROR + 0x086)
#define GATE_RESULT_INVALIDINPUT   (GATE_RESULT_ERROR + 0x087)
#define GATE_RESULT_INVALIDOUTPUT   (GATE_RESULT_ERROR + 0x088)
#define GATE_RESULT_BUFFERTOOSMALL   (GATE_RESULT_ERROR + 0x089)
#define GATE_RESULT_NODATA   (GATE_RESULT_ERROR + 0x08a)
#define GATE_RESULT_APPLICATIONERROR   (GATE_RESULT_ERROR + 0x100)
#define GATE_RESULT_LOGICALERROR   (GATE_RESULT_ERROR + 0x101)
#define GATE_RESULT_USERERROR   (GATE_RESULT_ERROR + 0x102)
#define GATE_RESULT_UNKNOWNERROR   (GATE_RESULT_ERROR + 0xfff)

Functions

GATE_CORE_API char const * gate_result_text (gate_result_t resultcode)
 Returns a text representation of the given result code.
GATE_CORE_API void gate_panic (gate_result_t resultcode, char const *message)
 Logs the given fatal error code and message and immediately stops the running process.

Detailed Description

Status, result and error code definitions.

Macro Definition Documentation

◆ GATE_RESULT_ERROR

#define GATE_RESULT_ERROR   -32768

Undefined error class

◆ GATE_RESULT_FAILED

#define GATE_RESULT_FAILED   (GATE_RESULT_ERROR + 0x001)

General failure, no detailed information

◆ GATE_RESULT_CANCELED

#define GATE_RESULT_CANCELED   (GATE_RESULT_ERROR + 0x002)

Operation was canceled (by user or logic)

◆ GATE_RESULT_INVALIDARG

#define GATE_RESULT_INVALIDARG   (GATE_RESULT_ERROR + 0x003)

An invalid argument or parameter was detected

◆ GATE_RESULT_ACCESSDENIED

#define GATE_RESULT_ACCESSDENIED   (GATE_RESULT_ERROR + 0x004)

Resource cannot be accessed in the current state

◆ GATE_RESULT_PERMISSIONDENIED

#define GATE_RESULT_PERMISSIONDENIED   (GATE_RESULT_ERROR + 0x005)

Resource cannot be accessed due to a permission problem

◆ GATE_RESULT_NOTDEFINED

#define GATE_RESULT_NOTDEFINED   (GATE_RESULT_ERROR + 0x006)

Mandatory requirement was not defined

◆ GATE_RESULT_NOTAVAILABLE

#define GATE_RESULT_NOTAVAILABLE   (GATE_RESULT_ERROR + 0x007)

Required resource is not available

◆ GATE_RESULT_NOTIMPLEMENTED

#define GATE_RESULT_NOTIMPLEMENTED   (GATE_RESULT_ERROR + 0x008)

Required feature(s) is not implemented

◆ GATE_RESULT_NOMATCH

#define GATE_RESULT_NOMATCH   (GATE_RESULT_ERROR + 0x009)

Search could not find a valid result

◆ GATE_RESULT_NOTSUPPORTED

#define GATE_RESULT_NOTSUPPORTED   (GATE_RESULT_ERROR + 0x00a)

Specific operation configuration is not supported by the implementation

◆ GATE_RESULT_NOTREQUIRED

#define GATE_RESULT_NOTREQUIRED   (GATE_RESULT_ERROR + 0x00b)

Requested operation is not required, the target state has been already reached

◆ GATE_RESULT_NOTREADY

#define GATE_RESULT_NOTREADY   (GATE_RESULT_ERROR + 0x00c)

Resource is not ready for the required operation

◆ GATE_RESULT_SECURITYBREACH

#define GATE_RESULT_SECURITYBREACH   (GATE_RESULT_ERROR + 0x00d)

Permission evaluation detected a security breach

◆ GATE_RESULT_ALREADYEXISTS

#define GATE_RESULT_ALREADYEXISTS   (GATE_RESULT_ERROR + 0x00e)

Requested creation of resource failed, because the resource does already exist

◆ GATE_RESULT_INVALIDSTATE

#define GATE_RESULT_INVALIDSTATE   (GATE_RESULT_ERROR + 0x00f)

Target is in a state that cannot process the requested action

◆ GATE_RESULT_OUTOFMEMORY

#define GATE_RESULT_OUTOFMEMORY   (GATE_RESULT_ERROR + 0x021)

Memory allocation or initialization failed

◆ GATE_RESULT_OUTOFRESOURCES

#define GATE_RESULT_OUTOFRESOURCES   (GATE_RESULT_ERROR + 0x022)

Required system resource could not be allocated/created/initialized

◆ GATE_RESULT_OUTOFBOUNDS

#define GATE_RESULT_OUTOFBOUNDS   (GATE_RESULT_ERROR + 0x023)

Access to an item outside the allowed range was rejected

◆ GATE_RESULT_NULLPOINTER

#define GATE_RESULT_NULLPOINTER   (GATE_RESULT_ERROR + 0x024)

Null-pointer was detected where a valid pointer is required

◆ GATE_RESULT_BADCAST

#define GATE_RESULT_BADCAST   (GATE_RESULT_ERROR + 0x025)

Type case failed due to type incompatibility

◆ GATE_RESULT_ARITHMETICERROR

#define GATE_RESULT_ARITHMETICERROR   (GATE_RESULT_ERROR + 0x026)

Calculation failed due to type/hardware/logical error

◆ GATE_RESULT_OVERFLOW

#define GATE_RESULT_OVERFLOW   (GATE_RESULT_ERROR + 0x027)

Numeric or resource overflow detected

◆ GATE_RESULT_UNDERFLOW

#define GATE_RESULT_UNDERFLOW   (GATE_RESULT_ERROR + 0x028)

Numeric or resource underflow detected

◆ GATE_RESULT_LOCKED

#define GATE_RESULT_LOCKED   (GATE_RESULT_ERROR + 0x029)

Resource is locked and cannot be accessed

◆ GATE_RESULT_TIMEOUT

#define GATE_RESULT_TIMEOUT   (GATE_RESULT_ERROR + 0x02a)

Wait-timeout occured

◆ GATE_RESULT_BADADDRESS

#define GATE_RESULT_BADADDRESS   (GATE_RESULT_ERROR + 0x02b)

Bad address was detected

◆ GATE_RESULT_BLOCKED

#define GATE_RESULT_BLOCKED   (GATE_RESULT_ERROR + 0x02c)

Blocking call was detected an canceled, as an immediate result was requested

◆ GATE_RESULT_DEVICEERROR

#define GATE_RESULT_DEVICEERROR   (GATE_RESULT_ERROR + 0x02d)

System device error was detected

◆ GATE_RESULT_EXECUTIONFAILED

#define GATE_RESULT_EXECUTIONFAILED   (GATE_RESULT_ERROR + 0x031)

Task execution failed in general

◆ GATE_RESULT_EXECUTIONINTERRUPTED

#define GATE_RESULT_EXECUTIONINTERRUPTED   (GATE_RESULT_ERROR + 0x032)

Task execution was interrupted

◆ GATE_RESULT_CRITICALERROR

#define GATE_RESULT_CRITICALERROR   (GATE_RESULT_ERROR + 0x033)

Critical internal error occured

◆ GATE_RESULT_UNKNOWNEXCEPTION

#define GATE_RESULT_UNKNOWNEXCEPTION   (GATE_RESULT_ERROR + 0x034)

Unknown/unspecified exception state detected

◆ GATE_RESULT_PRECONDITIONFAILED

#define GATE_RESULT_PRECONDITIONFAILED   (GATE_RESULT_ERROR + 0x035)

Required precondition was not fulfilled

◆ GATE_RESULT_PREPARATIONFAILED

#define GATE_RESULT_PREPARATIONFAILED   (GATE_RESULT_ERROR + 0x036)

Task preparation failed

◆ GATE_RESULT_BADINSTRUCTION

#define GATE_RESULT_BADINSTRUCTION   (GATE_RESULT_ERROR + 0x037)

Invalid instruction detected

◆ GATE_RESULT_INVALIDHEADER

#define GATE_RESULT_INVALIDHEADER   (GATE_RESULT_ERROR + 0x081)

Data header is invalid

◆ GATE_RESULT_INVALIDDATA

#define GATE_RESULT_INVALIDDATA   (GATE_RESULT_ERROR + 0x082)

Data is invalid in general

◆ GATE_RESULT_INVALIDCONTENT

#define GATE_RESULT_INVALIDCONTENT   (GATE_RESULT_ERROR + 0x083)

Payload content is invalid

◆ GATE_RESULT_INCORRECTSIZE

#define GATE_RESULT_INCORRECTSIZE   (GATE_RESULT_ERROR + 0x084)

A size or range parameter is invalid

◆ GATE_RESULT_INCORRECTTYPE

#define GATE_RESULT_INCORRECTTYPE   (GATE_RESULT_ERROR + 0x085)

Incorrect data type detected

◆ GATE_RESULT_ENDOFSTREAM

#define GATE_RESULT_ENDOFSTREAM   (GATE_RESULT_ERROR + 0x086)

Data resource has reached its current end-position

◆ GATE_RESULT_INVALIDINPUT

#define GATE_RESULT_INVALIDINPUT   (GATE_RESULT_ERROR + 0x087)

Given input data is invalid

◆ GATE_RESULT_INVALIDOUTPUT

#define GATE_RESULT_INVALIDOUTPUT   (GATE_RESULT_ERROR + 0x088)

Given output data is invalid

◆ GATE_RESULT_BUFFERTOOSMALL

#define GATE_RESULT_BUFFERTOOSMALL   (GATE_RESULT_ERROR + 0x089)

Data buffer does not meet size requirements

◆ GATE_RESULT_NODATA

#define GATE_RESULT_NODATA   (GATE_RESULT_ERROR + 0x08a)

No data available to access

◆ GATE_RESULT_APPLICATIONERROR

#define GATE_RESULT_APPLICATIONERROR   (GATE_RESULT_ERROR + 0x100)

Internal application error occured

◆ GATE_RESULT_LOGICALERROR

#define GATE_RESULT_LOGICALERROR   (GATE_RESULT_ERROR + 0x101)

Logical error condition detected

◆ GATE_RESULT_USERERROR

#define GATE_RESULT_USERERROR   (GATE_RESULT_ERROR + 0x102)

User input/interaction caused in error

◆ GATE_RESULT_UNKNOWNERROR

#define GATE_RESULT_UNKNOWNERROR   (GATE_RESULT_ERROR + 0xfff)

Unknown/unexpected native error code detected

Function Documentation

◆ gate_result_text()

GATE_CORE_API char const * gate_result_text ( gate_result_t resultcode)

Returns a text representation of the given result code.

Parameters
[in]resultcodeGATE_RESULT_* code to be translated
Returns
Pointer to static text representing the given result code

◆ gate_panic()

GATE_CORE_API void gate_panic ( gate_result_t resultcode,
char const * message )

Logs the given fatal error code and message and immediately stops the running process.

Parameters
[in]resultcodePointer to root node
[in]messageCompare function to evalute key
Returns
This function does not return and exits the running process