BLOCXX_NAMESPACE::Exception Class Reference

This class is the base of all exceptions thrown by BloCxx code. More...

#include <Exception.hpp>

Inheritance diagram for BLOCXX_NAMESPACE::Exception:

BLOCXX_NAMESPACE::AssertionException BLOCXX_NAMESPACE::CancellationDeniedException BLOCXX_NAMESPACE::CmdLineParserException BLOCXX_NAMESPACE::ConditionLockException BLOCXX_NAMESPACE::ConditionResourceException BLOCXX_NAMESPACE::DateTimeException BLOCXX_NAMESPACE::DeadlockException BLOCXX_NAMESPACE::EnumerationException BLOCXX_NAMESPACE::ExecErrorException BLOCXX_NAMESPACE::ExecMockObjectUnimplementedException BLOCXX_NAMESPACE::FileSystemException BLOCXX_NAMESPACE::FileSystemMockObjectUnimplementedException BLOCXX_NAMESPACE::GenericRWLockImplException BLOCXX_NAMESPACE::InvalidUTF8Exception BLOCXX_NAMESPACE::IOException BLOCXX_NAMESPACE::IPCMutexException BLOCXX_NAMESPACE::LoggerException BLOCXX_NAMESPACE::LogMessagePatternFormatterException BLOCXX_NAMESPACE::MD5Exception BLOCXX_NAMESPACE::NULLReferenceException BLOCXX_NAMESPACE::NULLValueException BLOCXX_NAMESPACE::OutOfBoundsException BLOCXX_NAMESPACE::ProcessErrorException BLOCXX_NAMESPACE::RegExCompileException BLOCXX_NAMESPACE::RegExExecuteException BLOCXX_NAMESPACE::RWLockerException BLOCXX_NAMESPACE::SafeCString::OverflowException BLOCXX_NAMESPACE::Secure::ProcessAbortException BLOCXX_NAMESPACE::SecureRandException BLOCXX_NAMESPACE::SelectException BLOCXX_NAMESPACE::SharedLibraryException BLOCXX_NAMESPACE::SocketAddressException BLOCXX_NAMESPACE::SocketException BLOCXX_NAMESPACE::SocketTimeoutException BLOCXX_NAMESPACE::StringConversionException BLOCXX_NAMESPACE::ThreadBarrierException BLOCXX_NAMESPACE::ThreadException BLOCXX_NAMESPACE::ThreadPoolException BLOCXX_NAMESPACE::TimeoutException BLOCXX_NAMESPACE::UnknownHostException BLOCXX_NAMESPACE::UnnamedPipeException BLOCXX_NAMESPACE::UUIDException

List of all members.

Public Member Functions

virtual ~Exception () throw ()
virtual const char * type () const
 Returns a string representing the concrete type.
virtual const char * getMessage () const
 Returns the message.
const char * getFile () const
 Returns the file.
int getLine () const
int getSubClassId () const
const Exception * getSubException () const
 Returns the sub exception if available, otherwise 0.
int getErrorCode () const
 Returns the error code representing the error which occurred.
virtual const char * what () const throw ()
 Returns getMessage().
virtual Exception * clone () const
 Make a copy of this exception object.
virtual void rethrow () const
 Re-throws the exception.
char * dupString (const char *str)
 Utility function to copy a string.

Static Public Attributes

static const int UNKNOWN_SUBCLASS_ID = -1
static const int UNKNOWN_ERROR_CODE = -1

Protected Member Functions

 Exception (const char *file, int line, const char *msg)
 This constructor is deprecated.
 Exception (const char *file, int line, const char *msg, int errorCode, const Exception *otherException=0, int subClassId=UNKNOWN_SUBCLASS_ID)
 Exception (int subClassId, const char *file, int line, const char *msg, int errorCode, const Exception *otherException=0)
 Exception (const Exception &e)
Exception & operator= (const Exception &rhs)
void swap (Exception &x)
void setSubClassId (int subClassId)
void setErrorCode (int errorCode)

Private Attributes

char * m_file
int m_line
char * m_msg
int m_subClassId
const Exception * m_subException
int m_errorCode

Detailed Description

This class is the base of all exceptions thrown by BloCxx code.

It cannot be constructed directly, only subclasses can be instantiated.

Creating a correct subclass is facilitated by the macros defined in this file.

Exceptions should be thrown by using one of the BLOCXX_THROW_* macros which inserts the file and line number among other helpful things.

Definition at line 65 of file Exception.hpp.

Constructor & Destructor Documentation

BLOCXX_NAMESPACE::Exception::Exception ( const char *  file,
int  line,
const char *  msg 
) [protected]

This constructor is deprecated.

Definition at line 86 of file Exception.cpp.

References BLOCXX_NAMESPACE::NonRecursiveMutex::acquire(), m_mutex, and BLOCXX_NAMESPACE::StackTrace::printStackTrace().

Referenced by operator=().

BLOCXX_NAMESPACE::Exception::Exception ( const char *  file,
int  line,
const char *  msg,
int  errorCode,
const Exception *  otherException = 0,
int  subClassId = UNKNOWN_SUBCLASS_ID 
) [protected]

Parameters:
file The filename of the code throwing the exception.
line The line of the code throwing the exception.
msg A human readable message associated with the exception.
errorCode A number identifying the specific error that caused this exception.
otherException A pointer to another exception. This allows for exception chaining, presumably otherException is the underlying cause that the current exception is being thrown. If otherException != 0, The new Exception instance will store and delete the result of calling otherException->clone(). otherException will not be saved.
subClassId Each subclass of Exception may create an id. getSubClassId() will return this value. You may pass UNKNOWN_SUBCLASS_ID if no id is required. blocxx Ids are be registered in BLOCXX_ExceptionIds.hpp.

Definition at line 120 of file Exception.cpp.

References BLOCXX_NAMESPACE::NonRecursiveMutex::acquire(), m_mutex, and BLOCXX_NAMESPACE::StackTrace::printStackTrace().

BLOCXX_NAMESPACE::Exception::Exception ( int  subClassId,
const char *  file,
int  line,
const char *  msg,
int  errorCode,
const Exception *  otherException = 0 
) [protected]

Definition at line 103 of file Exception.cpp.

References BLOCXX_NAMESPACE::NonRecursiveMutex::acquire(), m_mutex, and BLOCXX_NAMESPACE::StackTrace::printStackTrace().

BLOCXX_NAMESPACE::Exception::Exception ( const Exception &  e  )  [protected]

Definition at line 137 of file Exception.cpp.

References BLOCXX_NAMESPACE::NonRecursiveMutex::acquire(), and m_mutex.

BLOCXX_NAMESPACE::Exception::~Exception (  )  throw () [virtual]

Definition at line 151 of file Exception.cpp.

References BLOCXX_NAMESPACE::freeBuf(), m_file, m_msg, m_mutex, m_subException, and BLOCXX_NAMESPACE::NonRecursiveMutex::release().

Member Function Documentation

Exception & BLOCXX_NAMESPACE::Exception::operator= ( const Exception &  rhs  )  [protected]

Definition at line 169 of file Exception.cpp.

References Exception().

void BLOCXX_NAMESPACE::Exception::swap ( Exception &  x  )  [protected]

Definition at line 176 of file Exception.cpp.

References m_errorCode, m_file, m_line, m_msg, m_subClassId, m_subException, and BLOCXX_NAMESPACE::swap().

void BLOCXX_NAMESPACE::Exception::setSubClassId ( int  subClassId  )  [protected]

Definition at line 274 of file Exception.cpp.

void BLOCXX_NAMESPACE::Exception::setErrorCode ( int  errorCode  )  [protected]

Definition at line 308 of file Exception.cpp.

const char * BLOCXX_NAMESPACE::Exception::type (  )  const [virtual]

Returns a string representing the concrete type.

e.g. "SocketException". Will not return 0. This function will not throw. Derived class implementations must not throw.

Reimplemented in BLOCXX_NAMESPACE::OutOfBoundsException, BLOCXX_NAMESPACE::AssertionException, BLOCXX_NAMESPACE::CmdLineParserException, BLOCXX_NAMESPACE::ConditionLockException, BLOCXX_NAMESPACE::ConditionResourceException, BLOCXX_NAMESPACE::DateTimeException, BLOCXX_NAMESPACE::EnumerationException, BLOCXX_NAMESPACE::ExecErrorException, BLOCXX_NAMESPACE::ExecTimeoutException, BLOCXX_NAMESPACE::ExecBufferFullException, BLOCXX_NAMESPACE::ExecMockObjectUnimplementedException, BLOCXX_NAMESPACE::FileSystemException, BLOCXX_NAMESPACE::FileSystemMockObjectUnimplementedException, BLOCXX_NAMESPACE::GenericRWLockImplException, BLOCXX_NAMESPACE::IOException, BLOCXX_NAMESPACE::BadSignatureException, BLOCXX_NAMESPACE::IPCMutexException, BLOCXX_NAMESPACE::LoggerException, BLOCXX_NAMESPACE::LogMessagePatternFormatterException, BLOCXX_NAMESPACE::MD5Exception, BLOCXX_NAMESPACE::DeadlockException, BLOCXX_NAMESPACE::NULLValueException, BLOCXX_NAMESPACE::ProcessErrorException, BLOCXX_NAMESPACE::NULLReferenceException, BLOCXX_NAMESPACE::RegExCompileException, BLOCXX_NAMESPACE::RegExExecuteException, BLOCXX_NAMESPACE::RWLockerException, BLOCXX_NAMESPACE::SafeCString::OverflowException, BLOCXX_NAMESPACE::Secure::ProcessAbortException, BLOCXX_NAMESPACE::SecureRandException, BLOCXX_NAMESPACE::SelectException, BLOCXX_NAMESPACE::SharedLibraryException, BLOCXX_NAMESPACE::SocketTimeoutException, BLOCXX_NAMESPACE::UnknownHostException, BLOCXX_NAMESPACE::SocketAddressException, BLOCXX_NAMESPACE::SocketException, BLOCXX_NAMESPACE::SSLException, BLOCXX_NAMESPACE::StringConversionException, BLOCXX_NAMESPACE::CancellationDeniedException, BLOCXX_NAMESPACE::ThreadException, BLOCXX_NAMESPACE::ThreadBarrierException, BLOCXX_NAMESPACE::ThreadPoolException, BLOCXX_NAMESPACE::TimeoutException, BLOCXX_NAMESPACE::UnnamedPipeException, BLOCXX_NAMESPACE::InvalidUTF8Exception, and BLOCXX_NAMESPACE::UUIDException.

Definition at line 189 of file Exception.cpp.

Referenced by BLOCXX_NAMESPACE::operator<<(), BLOCXX_NAMESPACE::runRunnable(), and BLOCXX_NAMESPACE::Thread::threadRunner().

const char * BLOCXX_NAMESPACE::Exception::getMessage (  )  const [virtual]

Returns the message.

May return 0. This function will not throw. Derived class implementations must not throw.

Definition at line 203 of file Exception.cpp.

References m_msg.

Referenced by BLOCXX_NAMESPACE::LogAppender::createLogAppender(), and BLOCXX_NAMESPACE::operator<<().

const char * BLOCXX_NAMESPACE::Exception::getFile (  )  const

Returns the file.

May return 0.

Definition at line 209 of file Exception.cpp.

References m_file.

Referenced by BLOCXX_NAMESPACE::operator<<().

int BLOCXX_NAMESPACE::Exception::getLine (  )  const

Definition at line 196 of file Exception.cpp.

References m_line.

Referenced by BLOCXX_NAMESPACE::operator<<().

int BLOCXX_NAMESPACE::Exception::getSubClassId (  )  const

Definition at line 267 of file Exception.cpp.

const Exception * BLOCXX_NAMESPACE::Exception::getSubException (  )  const

Returns the sub exception if available, otherwise 0.

Definition at line 294 of file Exception.cpp.

Referenced by BLOCXX_NAMESPACE::operator<<().

int BLOCXX_NAMESPACE::Exception::getErrorCode (  )  const

Returns the error code representing the error which occurred.

Code are unique only in the scope of the derived exception class. May return UNKNONWN_ERROR_CODE if the error is unavailable.

Definition at line 301 of file Exception.cpp.

Referenced by BLOCXX_NAMESPACE::operator<<().

const char * BLOCXX_NAMESPACE::Exception::what (  )  const throw () [virtual]

Returns getMessage().

Definition at line 260 of file Exception.cpp.

Exception * BLOCXX_NAMESPACE::Exception::clone (  )  const [virtual]

Make a copy of this exception object.

If allocation fails, return 0. Subclasses need to override this function. This function must not throw. Here is an example of how to implement this in a derived class:

virtual DerivedException* clone() const { return new(std::nothrow) DerivedException(*this); }

Reimplemented in BLOCXX_NAMESPACE::OutOfBoundsException, BLOCXX_NAMESPACE::AssertionException, BLOCXX_NAMESPACE::CmdLineParserException, BLOCXX_NAMESPACE::ConditionLockException, BLOCXX_NAMESPACE::ConditionResourceException, BLOCXX_NAMESPACE::DateTimeException, BLOCXX_NAMESPACE::EnumerationException, BLOCXX_NAMESPACE::ExecErrorException, BLOCXX_NAMESPACE::ExecTimeoutException, BLOCXX_NAMESPACE::ExecBufferFullException, BLOCXX_NAMESPACE::ExecMockObjectUnimplementedException, BLOCXX_NAMESPACE::FileSystemException, BLOCXX_NAMESPACE::FileSystemMockObjectUnimplementedException, BLOCXX_NAMESPACE::GenericRWLockImplException, BLOCXX_NAMESPACE::IOException, BLOCXX_NAMESPACE::BadSignatureException, BLOCXX_NAMESPACE::IPCMutexException, BLOCXX_NAMESPACE::LoggerException, BLOCXX_NAMESPACE::LogMessagePatternFormatterException, BLOCXX_NAMESPACE::MD5Exception, BLOCXX_NAMESPACE::DeadlockException, BLOCXX_NAMESPACE::NULLValueException, BLOCXX_NAMESPACE::ProcessErrorException, BLOCXX_NAMESPACE::NULLReferenceException, BLOCXX_NAMESPACE::RegExCompileException, BLOCXX_NAMESPACE::RegExExecuteException, BLOCXX_NAMESPACE::RWLockerException, BLOCXX_NAMESPACE::SafeCString::OverflowException, BLOCXX_NAMESPACE::Secure::ProcessAbortException, BLOCXX_NAMESPACE::SecureRandException, BLOCXX_NAMESPACE::SelectException, BLOCXX_NAMESPACE::SharedLibraryException, BLOCXX_NAMESPACE::SocketTimeoutException, BLOCXX_NAMESPACE::UnknownHostException, BLOCXX_NAMESPACE::SocketAddressException, BLOCXX_NAMESPACE::SocketException, BLOCXX_NAMESPACE::SSLException, BLOCXX_NAMESPACE::StringConversionException, BLOCXX_NAMESPACE::CancellationDeniedException, BLOCXX_NAMESPACE::ThreadException, BLOCXX_NAMESPACE::ThreadBarrierException, BLOCXX_NAMESPACE::ThreadPoolException, BLOCXX_NAMESPACE::TimeoutException, BLOCXX_NAMESPACE::UnnamedPipeException, BLOCXX_NAMESPACE::InvalidUTF8Exception, and BLOCXX_NAMESPACE::UUIDException.

Definition at line 281 of file Exception.cpp.

void BLOCXX_NAMESPACE::Exception::rethrow (  )  const [virtual]

Re-throws the exception.

All derived classes should override this which makes it possible to catch a base class Exception and still re-thrown the derived class.

Reimplemented in BLOCXX_NAMESPACE::OutOfBoundsException, BLOCXX_NAMESPACE::AssertionException, BLOCXX_NAMESPACE::CmdLineParserException, BLOCXX_NAMESPACE::ConditionLockException, BLOCXX_NAMESPACE::ConditionResourceException, BLOCXX_NAMESPACE::DateTimeException, BLOCXX_NAMESPACE::EnumerationException, BLOCXX_NAMESPACE::ExecErrorException, BLOCXX_NAMESPACE::ExecTimeoutException, BLOCXX_NAMESPACE::ExecBufferFullException, BLOCXX_NAMESPACE::ExecMockObjectUnimplementedException, BLOCXX_NAMESPACE::FileSystemException, BLOCXX_NAMESPACE::FileSystemMockObjectUnimplementedException, BLOCXX_NAMESPACE::GenericRWLockImplException, BLOCXX_NAMESPACE::IOException, BLOCXX_NAMESPACE::BadSignatureException, BLOCXX_NAMESPACE::IPCMutexException, BLOCXX_NAMESPACE::LoggerException, BLOCXX_NAMESPACE::LogMessagePatternFormatterException, BLOCXX_NAMESPACE::MD5Exception, BLOCXX_NAMESPACE::DeadlockException, BLOCXX_NAMESPACE::NULLValueException, BLOCXX_NAMESPACE::ProcessErrorException, BLOCXX_NAMESPACE::NULLReferenceException, BLOCXX_NAMESPACE::RegExCompileException, BLOCXX_NAMESPACE::RegExExecuteException, BLOCXX_NAMESPACE::RWLockerException, BLOCXX_NAMESPACE::SafeCString::OverflowException, BLOCXX_NAMESPACE::Secure::ProcessAbortException, BLOCXX_NAMESPACE::SecureRandException, BLOCXX_NAMESPACE::SelectException, BLOCXX_NAMESPACE::SharedLibraryException, BLOCXX_NAMESPACE::SocketTimeoutException, BLOCXX_NAMESPACE::UnknownHostException, BLOCXX_NAMESPACE::SocketAddressException, BLOCXX_NAMESPACE::SocketException, BLOCXX_NAMESPACE::SSLException, BLOCXX_NAMESPACE::StringConversionException, BLOCXX_NAMESPACE::CancellationDeniedException, BLOCXX_NAMESPACE::ThreadException, BLOCXX_NAMESPACE::ThreadBarrierException, BLOCXX_NAMESPACE::ThreadPoolException, BLOCXX_NAMESPACE::TimeoutException, BLOCXX_NAMESPACE::UnnamedPipeException, BLOCXX_NAMESPACE::InvalidUTF8Exception, and BLOCXX_NAMESPACE::UUIDException.

Definition at line 287 of file Exception.cpp.

char * BLOCXX_NAMESPACE::Exception::dupString ( const char *  str  ) 

Utility function to copy a string.

This function will not throw--if allocation fails, 0 is returned. The result must be free[]'d. if str == 0, 0 is returned. TODO: This function doesn't really belong on this class, but so far only this class and subclasses have a use for it.

Definition at line 71 of file Exception.cpp.

Member Data Documentation

const int BLOCXX_NAMESPACE::Exception::UNKNOWN_SUBCLASS_ID = -1 [static]

Definition at line 112 of file Exception.hpp.

const int BLOCXX_NAMESPACE::Exception::UNKNOWN_ERROR_CODE = -1 [static]

Definition at line 113 of file Exception.hpp.

Referenced by BLOCXX_NAMESPACE::operator<<().

char* BLOCXX_NAMESPACE::Exception::m_file [private]

Definition at line 175 of file Exception.hpp.

Referenced by getFile(), swap(), and ~Exception().

int BLOCXX_NAMESPACE::Exception::m_line [private]

Definition at line 176 of file Exception.hpp.

Referenced by getLine(), and swap().

char* BLOCXX_NAMESPACE::Exception::m_msg [private]

Definition at line 177 of file Exception.hpp.

Referenced by getMessage(), swap(), and ~Exception().

int BLOCXX_NAMESPACE::Exception::m_subClassId [private]

Definition at line 178 of file Exception.hpp.

Referenced by swap().

const Exception* BLOCXX_NAMESPACE::Exception::m_subException [private]

Definition at line 179 of file Exception.hpp.

Referenced by swap(), and ~Exception().

int BLOCXX_NAMESPACE::Exception::m_errorCode [private]

Definition at line 180 of file Exception.hpp.

Referenced by swap().

The documentation for this class was generated from the following files:
Generated on Wed Feb 25 19:05:04 2009 for blocxx by  doxygen 1.5.6