OpResult.h

Go to the documentation of this file.

// Copyright (c) 2016 Digital Barriers

#pragma once
#include <limits.h>

#ifdef __cplusplus
namespace EdgeVisDecoderSDK
{
  extern "C" {
#endif

    typedef enum OpResult
    {
      OR_Success = 0,               
      OR_Failed = -2147483647 - 1,  
      OR_AuthFailed,                
      OR_ConnectionFailed,          
      OR_QueryTimeout,              
      OR_NotImplemented,            
      OR_NotSupported,              
      OR_EncoderNotSupported,       
      OR_ServerCommsFailure,        
      OR_CantOpenStream,            
      OR_NotConnected,              
      OR_InvalidEncoder,            
      OR_EncoderDisconnected,       
      OR_InvalidStream,             
      OR_InvalidTransport,          
      OR_SettingNotValid,           
      OR_ConfigSettingsFailed,      
      OR_PermissionDenied,          
      OR_InvalidProfileName,        
      OR_InvalidCameraInput,        
      OR_ServiceInUse,              
      OR_ServiceBusy,               
      OR_StreamInUse,               
      OR_EnhanceAreaBadSize,        
      OR_EnhanceAreaBadPos,         
      OR_InvalidEnhanceQuality,     
      OR_InvalidEnhanceFrameIdx,    
      OR_InvalidPortName,           
      OR_InvalidParams,             
      OR_InvalidEncoderAddress,     
      OR_CantOpenSerialStream,      
      OR_InvalidFilePath,           
      OR_CryptoVerifyFailed,        
      OR_InvalidService,            
      OR_IDConflict,                
      OR_IDInvalid,                 
      OR_DiskFull,                  
      OR_IOError,                   
      OR_CorruptFile,               
      OR_NoArchiveFootage,          
      OR_NoLicense,                 
      OR_LicenseDisabled,           
      OR_NewPasswordRequired,       
      OR_ArchivePlaybackDisabled,   
      OR_LicenseGraceExpired,       
      OR_AccountDisabled,           
      OR_AccountInactive,           
      OR_AccountLocked,             
      OR_NotificationNotfound,      
      OR_LicenseError,              
      OR_Deprecated,                
      OR_TooManyRequests,           
      OR_AlreadyDownloading,        
      OR_TooManyRecordings,         
      OR_AccountInUse,              
      OR_IncompatibleVersion,       
      OR_FileAlreadyExported,       
      OR_TooManyRules,              
      OR_TooManyActions,            
      OR_Cancelled,                 
      OR_TMSTokenNotObtained,       
      OR_TMSRequestFailed,          
      OR_TMSRequestTimedOut,        
      OR_CryptoUpgradeAvailable,    
      OR_CryptoNegotiationFailed,   
      OR_CryptoProtocolError,       
      OR_BadClusterConfig,          
      OR_RestInvalidResponse,       
      OR_RestBadRequest,            
      OR_RestUnauthorized,          
      OR_RestForbidden,             
      OR_RestServerError,           
      OR_RestNotFound,              
      OR_MFAEnrolmentRequired,      
      OR_MFARequired,               
      OR_MFAInvalidCode,            
      OR_MFACodeReuse,              
      OR_MFAEmergencyCodesExhausted,
      OR_MFAInvalidEmergencyCode,   
      OR_MFAEmergencyCodeReuse,     
      OR_BadRequest,                
      OR_ServerError,               
      OR_ServerIDMismatch,          
      OR_InvalidDevice,             
      OR_SSOOpenIdNotEnabled,       
      OR_SSOOpenIdNotSupported,     
      OR_SSOOpenIdAuthCodeRequired, 
      OR_WebLoginRequired,          
      OR_DNSFailure,                

      //Keep this as the last entry in the enum 
      OR_Unknown                    
    } OpResult;

    inline const char* OpResultToString(OpResult res)
    {
      switch (res)
      {
      case OR_Success:                    return "The operation completed successfully";
      case OR_Failed:                     return "The operation failed";
      case OR_AuthFailed:                 return "Authorisation failed";
      case OR_ConnectionFailed:           return "The connection failed";
      case OR_QueryTimeout:               return "The query timed out";
      case OR_NotImplemented:             return "Function or feature has not been implemented";
      case OR_NotSupported:               return "Function or feature is not supported on the asset";
      case OR_EncoderNotSupported:        return "The encoder is not supported";
      case OR_ServerCommsFailure:         return "The communication with the server failed";
      case OR_CantOpenStream:             return "The stream cannot be opened";
      case OR_NotConnected:               return "The asset is not connected";
      case OR_InvalidEncoder:             return "The encoder is invalid";
      case OR_EncoderDisconnected:        return "The encoder has disconnected";
      case OR_InvalidStream:              return "The stream is invalid";
      case OR_InvalidTransport:           return "The transport type is invalid";
      case OR_SettingNotValid:            return "The setting is not valid";
      case OR_ConfigSettingsFailed:       return "The configuration setting failed";
      case OR_PermissionDenied:           return "Permission has been denied for this account";
      case OR_InvalidProfileName:         return "The profile name is invalid";
      case OR_InvalidCameraInput:         return "The camera input is invalid";
      case OR_ServiceInUse:               return "The service is in use";
      case OR_ServiceBusy:                return "The service is busy";
      case OR_StreamInUse:                return "The stream is in use by another account";
      case OR_EnhanceAreaBadSize:         return "The full resolution area size is not within the current frame";
      case OR_EnhanceAreaBadPos:          return "The full resolution area position is not within the current frame";
      case OR_InvalidEnhanceQuality:      return "The full resolution quality is not valid";
      case OR_InvalidEnhanceFrameIdx:     return "The full resolution index is not valid";
      case OR_InvalidPortName:            return "The name of the port is not valid";
      case OR_InvalidParams:              return "The parameters are not valid";
      case OR_InvalidEncoderAddress:      return "The address of the encoder is not valid";
      case OR_CantOpenSerialStream:       return "The serial stream can not be opened";
      case OR_InvalidFilePath:            return "The file path is invalid";
      case OR_CryptoVerifyFailed:         return "The verification of the encryption key failed";
      case OR_InvalidService:             return "The service is not valid";
      case OR_IDConflict:                 return "The ID of the alarm rule is in conflict";
      case OR_IDInvalid:                  return "The ID if the alarm rule is not valid";
      case OR_DiskFull:                   return "The Disk is full";
      case OR_IOError:                    return "There has been read/write error";
      case OR_CorruptFile:                return "The file is corrupt";
      case OR_NoArchiveFootage:           return "There is no archive footage available, possibly it has not yet been recorded";
      case OR_NoLicense:                  return "There are no viewer licenses available";
      case OR_LicenseDisabled:            return "The users license has been disabled";
      case OR_NewPasswordRequired:        return "The users must set a new password";
      case OR_ArchivePlaybackDisabled:    return "The archive playback is currently disabled";
      case OR_LicenseGraceExpired:        return "The license has a grace period set";
      case OR_AccountDisabled:            return "The user account has been disabled";
      case OR_AccountInactive:            return "The user account has been marked as inactive";
      case OR_AccountLocked:              return "The user account has been locked";
      case OR_NotificationNotfound:       return "The notification has not been found";
      case OR_LicenseError:               return "Feature not licensed";
      case OR_Deprecated:                 return "Feature is deprecated";
      case OR_TooManyRequests:            return "The GOP download service cannot accept another GOP request";
      case OR_AlreadyDownloading:         return "The GOP download service is already downloading";
      case OR_TooManyRecordings:          return "The GOP download request includes too many recording entries";
      case OR_AccountInUse:               return "The server has single sign-on enabled and the user is logged in already";
      case OR_IncompatibleVersion:        return "The server is not compatible with this Decoder SDK version";
      case OR_FileAlreadyExported:        return "The file has already been exported";
      case OR_TooManyRules:               return "There are too many rules on the encoder to add a new one";
      case OR_TooManyActions:             return "The rule contains more actions than the encoder can support";
      case OR_Cancelled:                  return "The requested operation was cancelled";
      case OR_TMSTokenNotObtained:        return "Valid TMS web token was not obtained";
      case OR_TMSRequestFailed:           return "Request to list/download TMS files failed";
      case OR_TMSRequestTimedOut:         return "Request to list/download TMS files timed out";
      case OR_CryptoUpgradeAvailable:     return "An upgraded server key is available to enable stronger encryption";
      case OR_CryptoNegotiationFailed:    return "The negotiation of the encryption scheme failed";
      case OR_CryptoProtocolError:        return "The client and server could not agree on a protocol that both supported - this may be due to a supplied encryption key version";
      case OR_BadClusterConfig:           return "The cluster config could not be parsed or was inconsistent with the current server address";
      case OR_RestInvalidResponse:        return "A REST API requrest has returned an invalid response";
      case OR_RestBadRequest:             return "A REST API request has returned bad request";
      case OR_RestUnauthorized:           return "A REST API request has been rejected as the user in not authorized";
      case OR_RestForbidden:              return "The REST API request was for a forbidden URL";
      case OR_RestServerError:            return "The REST API server has encountered an error";
      case OR_RestNotFound:               return "The REST API request has failed with a not found error";
      case OR_MFAEnrolmentRequired:       return "The user is required by the server to setup two factor authentication on their device";
      case OR_MFARequired:                return "The user is required to provide additional authentication credentials";
      case OR_MFAInvalidCode:             return "The one time passcode the user provided is invalid";
      case OR_MFACodeReuse:               return "The one time passcode provided has already been used";
      case OR_MFAEmergencyCodesExhausted: return "The account has no emergency one time passcodes remaining";
      case OR_MFAInvalidEmergencyCode:    return "The emergency one time passcode entered is invalid";
      case OR_MFAEmergencyCodeReuse:      return "The emergency one time passcode has previously been used: emergency codes can only be used once";
      case OR_BadRequest:                 return "The request was malformed and was rejected by the server";
      case OR_ServerError:                return "An internal error occurred on the server during the previous request";
      case OR_ServerIDMismatch:           return "The server that has been contacted has a different UUID or encryption ID from the one expected";
      case OR_InvalidDevice:              return "The device is not valid";
      case OR_SSOOpenIdNotEnabled:        return "This user does not have SSO OpenId login enabled";
      case OR_SSOOpenIdNotSupported:      return "SSO OpenId is not supported on this platform";
      case OR_SSOOpenIdAuthCodeRequired:  return "No authentication code was supplied for SSO OpenId login";
      case OR_WebLoginRequired:           return "The user must log in to the web portal to proceed with login";
      case OR_DNSFailure:                 return "An IP address could not be resolved so the server is not reachable";
      case OR_Unknown:                    return "Unknown error";
      }

      return "Unknown error";
    }

#ifdef __cplusplus
  }
}
#endif