Digital Authentication Framework  6.0.1.37
Public Types | Public Member Functions | List of all members
DAError Class Referenceabstract

Interface for error reporting. More...

#include <DigitalAuthenticationFramework.h>

Inheritance diagram for DAError:
BasicError

Public Types

enum  {
  SUCCESS = 0, NO_MEMORY = 1, NOT_PROVISIONED = 2, DEVICE_NOT_FOUND = 3,
  NO_MORE_SESSIONS = 4, DEVICE_DISCONNECTED = 5, DEVICE_PROTOCOL_ERR = 6, BAD_AUTH_TOKEN = 7,
  KEY_NOT_FOUND = 8, ATTRIB_NOT_FOUND = 9, MECH_NOT_FOUND = 10, VERIFY_FAILED = 11,
  NOT_IMPLEMENTED = 12, BAD_PARAMETERS = 13, OS_ERROR = 14, UNSUPPORTED_HASH = 15
}
 

Public Member Functions

virtual ~DAError ()
 virtual destructor More...
 
virtual int getCode ()=0
 get error code More...
 
bool isError ()
 test if error has occurred More...
 
virtual void clear ()=0
 reset the current error state.
 
virtual void getAsStringUTF8 (std::string &errmsg)=0
 get error as string message. More...
 

Detailed Description

Interface for error reporting.

Member Enumeration Documentation

anonymous enum
Enumerator
SUCCESS 

No error occurred.

NO_MEMORY 

General memory allocation failure.

NOT_PROVISIONED 

Driver has not been set up with a device.

DEVICE_NOT_FOUND 

Cannot find the device.

NO_MORE_SESSIONS 

The maximum allowed number of concurrent sessions are already connected.

DEVICE_DISCONNECTED 

Link to device lost unexpectedly.

DEVICE_PROTOCOL_ERR 

Error from protocol stack talking to device.

BAD_AUTH_TOKEN 

authToken provided to CreateSession was bad

KEY_NOT_FOUND 

Requested key does not exist.

ATTRIB_NOT_FOUND 

Requested attribute not available.

MECH_NOT_FOUND 

Requested mechanism is not supported.

VERIFY_FAILED 

Verification of signature failed.

NOT_IMPLEMENTED 

Method is not implemented.

BAD_PARAMETERS 

Missing or invalid parameters to method.

OS_ERROR 

Operating system call failed.

UNSUPPORTED_HASH 

Requested hash function cannot be used here.

Constructor & Destructor Documentation

virtual DAError::~DAError ( )
virtual

virtual destructor

Member Function Documentation

virtual void DAError::getAsStringUTF8 ( std::string &  errmsg)
pure virtual

get error as string message.

Note there is deliberately no success/failure indication for this method.

Implemented in BasicError.

virtual int DAError::getCode ( )
pure virtual

get error code

Returns
SUCCESS if no error, otherwise NO_MEMORY, NOT_PROVISIONED etc

Implemented in BasicError.

bool DAError::isError ( )

test if error has occurred


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