CPKIFMessageException Class Reference
#include <PKIFMessageException.h>
Detailed Description
CPKIFMessageException is the exception thrown by cache-related mediator and colleague objects. It is derived from PKIFException.As a general rule, all PKIF operations should be performed inside a try/catch block capable of catching all CPKIFExceptions and/or all std::exceptions. CPKIFExceptions, or derived exception classes, are used to indicate operational exceptions within PKIF. std::exception objects are used to indicate out of memory errors. CPKIFExceptions are derived from std::exceptions. Thus all exceptions can be caught by catching std::exceptions. CPKIFException information can be obtained by casting the exception using dynamic_cast.
TSP-enforcing: No
Definition at line 28 of file PKIFMessageException.h.
Public Member Functions | |
| CPKIFMessageException (int subComponentID, int errorCode) | |
| CPKIFMessageException (int subComponentID, int errorCode, char *fileName, int lineNumber) | |
| CPKIFMessageException (int subComponentID, int errorCode, const char *errorDescription) | |
| CPKIFMessageException (int subComponentID, int errorCode, const char *errorDescription, char *fileName, int lineNumber) | |
| virtual | ~CPKIFMessageException (void) STDLIB_SUPER_THROW |
Constructor & Destructor Documentation
| CPKIFMessageException::CPKIFMessageException | ( | int | subComponentID, | |
| int | errorCode | |||
| ) |
Interface: External
These five constructors provide means of creating exception objects containing various combinations of exception-related information.
- Returns:
- None
- Parameters:
-
subComponentID [in] Integer identifying the subcomponent that generated the exception errorCode [in] Integer identifying the error condition that resulted in the exception
Definition at line 18 of file CACMessageException.cpp.
| CPKIFMessageException::CPKIFMessageException | ( | int | subComponentID, | |
| int | errorCode, | |||
| char * | fileName, | |||
| int | lineNumber | |||
| ) |
Interface: External
These five constructors provide means of creating exception objects containing various combinations of exception-related information.
- Returns:
- None
- Parameters:
-
subComponentID [in] Integer identifying the subcomponent that generated the exception errorCode [in] Integer identifying the error condition that resulted in the exception fileName [in] Pointer to a NULL terminated string identifying the source file from which the exception was thrown lineNumber [in] Integer indicating the line number of the source file identified by the fileName parameter from which the exception was thrown
Definition at line 34 of file CACMessageException.cpp.
| CPKIFMessageException::CPKIFMessageException | ( | int | subComponentID, | |
| int | errorCode, | |||
| const char * | errorDescription | |||
| ) |
Interface: External
These five constructors provide means of creating exception objects containing various combinations of exception-related information.
- Returns:
- None
- Parameters:
-
subComponentID [in] Integer identifying the subcomponent that generated the exception errorCode [in] Integer identifying the error condition that resulted in the exception errorDescription [in] Pointer to a NULL terminated string containing a free form textual description of the error condition that resulted in the exception
Definition at line 55 of file CACMessageException.cpp.
| CPKIFMessageException::CPKIFMessageException | ( | int | subComponentID, | |
| int | errorCode, | |||
| const char * | errorDescription, | |||
| char * | fileName, | |||
| int | lineNumber | |||
| ) |
Interface: External
These five constructors provide means of creating exception objects containing various combinations of exception-related information.
- Returns:
- None
- Parameters:
-
subComponentID [in] Integer identifying the subcomponent that generated the exception errorCode [in] Integer identifying the error condition that resulted in the exception errorDescription [in] Pointer to a NULL terminated string containing a free form textual description of the error condition that resulted in the exception fileName [in] Pointer to a NULL terminated string identifying the source file from which the exception was thrown lineNumber [in] Integer indicating the line number of the source file identified by the fileName parameter from which the exception was thrown
Definition at line 74 of file CACMessageException.cpp.
| CPKIFMessageException::~CPKIFMessageException | ( | void | ) | [virtual] |
The documentation for this class was generated from the following files:
