CPKIFCacheException Class Reference

#include <PKIFCacheException.h>

Inheritance diagram for CPKIFCacheException:

[legend]

Collaboration diagram for CPKIFCacheException:

[legend]

List of all members.

---

Detailed Description

CPKIFCacheException objects are thrown by cache-related mediator and colleague objects. It is derived from CPKIFException.

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 PKIFCacheException.h.

Public Member Functions
	CPKIFCacheException (int subComponentID, int errorCode)
	CPKIFCacheException (int subComponentID, int errorCode, char *fileName, int lineNumber)
	CPKIFCacheException (int subComponentID, int errorCode, const char *errorDescription)
	CPKIFCacheException (int subComponentID, int errorCode, const char *errorDescription, char *fileName, int lineNumber)
virtual	~CPKIFCacheException (void) STDLIB_SUPER_THROW

---

Constructor & Destructor Documentation

CPKIFCacheException::CPKIFCacheException	(	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 31 of file CACCacheException.cpp.

CPKIFCacheException::CPKIFCacheException	(	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 47 of file CACCacheException.cpp.

CPKIFCacheException::CPKIFCacheException	(	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 67 of file CACCacheException.cpp.

CPKIFCacheException::CPKIFCacheException	(	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 85 of file CACCacheException.cpp.

CPKIFCacheException::~CPKIFCacheException

(

void

)

[virtual]

Interface: External

This function destroys CPKIFCacheException objects

Returns:

None

Definition at line 19 of file CACCacheException.cpp.

---

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

• PKIFCacheException.h
• CACCacheException.cpp