BLOCXX_NAMESPACE::Exception

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::CryptographicRandomNumberException BLOCXX_NAMESPACE::DateTimeException BLOCXX_NAMESPACE::DeadlockException BLOCXX_NAMESPACE::EnumerationException BLOCXX_NAMESPACE::ExecBufferFullException BLOCXX_NAMESPACE::ExecErrorException BLOCXX_NAMESPACE::ExecTimeoutException BLOCXX_NAMESPACE::FileSystemException BLOCXX_NAMESPACE::InvalidUTF8Exception BLOCXX_NAMESPACE::IOException BLOCXX_NAMESPACE::LoggerException BLOCXX_NAMESPACE::LogMessagePatternFormatterException BLOCXX_NAMESPACE::MD5Exception BLOCXX_NAMESPACE::NULLCOWIntrusiveReferenceException BLOCXX_NAMESPACE::NULLCOWReferenceException BLOCXX_NAMESPACE::NULLReferenceException BLOCXX_NAMESPACE::NULLValueException BLOCXX_NAMESPACE::OutOfBoundsException BLOCXX_NAMESPACE::RegExCompileException BLOCXX_NAMESPACE::RegExExecuteException BLOCXX_NAMESPACE::RWLockerException 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 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.
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, int errorCode, const Exception *otherException=0, int subClassId=UNKNOWN_SUBCLASS_ID)
 
Parameters:
file The filename of the code throwing the exception.

 Exception (const Exception &e)
Exception & operator= (const Exception &rhs)
void swap (Exception &x)
virtual ~Exception () throw ()
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 64 of file Exception.hpp.

Constructor & Destructor Documentation

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.

Parameters:
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. OW Ids are be registered in BLOCXX_ExceptionIds.hpp.

Definition at line 85 of file Exception.cpp.

References BLOCXX_NAMESPACE::StackTrace::printStackTrace().

Referenced by clone(), and operator=().

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

Definition at line 102 of file Exception.cpp.

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

Definition at line 116 of file Exception.cpp.

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

Member Function Documentation

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

Definition at line 134 of file Exception.cpp.

References Exception().

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

Definition at line 141 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 234 of file Exception.cpp.

References m_subClassId.

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

Definition at line 262 of file Exception.cpp.

References m_errorCode.

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::NULLCOWIntrusiveReferenceException, BLOCXX_NAMESPACE::NULLCOWReferenceException, BLOCXX_NAMESPACE::CryptographicRandomNumberException, BLOCXX_NAMESPACE::DateTimeException, BLOCXX_NAMESPACE::EnumerationException, BLOCXX_NAMESPACE::ExecTimeoutException, BLOCXX_NAMESPACE::ExecBufferFullException, BLOCXX_NAMESPACE::ExecErrorException, BLOCXX_NAMESPACE::FileSystemException, BLOCXX_NAMESPACE::IOException, BLOCXX_NAMESPACE::BadSignatureException, BLOCXX_NAMESPACE::LoggerException, BLOCXX_NAMESPACE::LogMessagePatternFormatterException, BLOCXX_NAMESPACE::MD5Exception, BLOCXX_NAMESPACE::DeadlockException, BLOCXX_NAMESPACE::NULLValueException, BLOCXX_NAMESPACE::NULLReferenceException, BLOCXX_NAMESPACE::RegExCompileException, BLOCXX_NAMESPACE::RegExExecuteException, BLOCXX_NAMESPACE::RWLockerException, 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 154 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 168 of file Exception.cpp.

References m_msg.

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

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

Returns the file.

May return 0.

Definition at line 174 of file Exception.cpp.

References m_file.

Referenced by BLOCXX_NAMESPACE::operator<<().

int BLOCXX_NAMESPACE::Exception::getLine (  )  const

Definition at line 161 of file Exception.cpp.

References m_line.

Referenced by BLOCXX_NAMESPACE::operator<<().

int BLOCXX_NAMESPACE::Exception::getSubClassId (  )  const

Definition at line 227 of file Exception.cpp.

References m_subClassId.

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

Returns the sub exception if available, otherwise 0.

Definition at line 248 of file Exception.cpp.

References m_subException.

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 255 of file Exception.cpp.

References m_errorCode.

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

Returns getMessage().

Definition at line 220 of file Exception.cpp.

References getMessage().

Referenced by BLOCXX_NAMESPACE::BaseStreamBuffer::buffer_out(), BLOCXX_NAMESPACE::runRunnable(), and BLOCXX_NAMESPACE::BaseStreamBuffer::underflow().

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::NULLCOWIntrusiveReferenceException, BLOCXX_NAMESPACE::NULLCOWReferenceException, BLOCXX_NAMESPACE::CryptographicRandomNumberException, BLOCXX_NAMESPACE::DateTimeException, BLOCXX_NAMESPACE::EnumerationException, BLOCXX_NAMESPACE::ExecTimeoutException, BLOCXX_NAMESPACE::ExecBufferFullException, BLOCXX_NAMESPACE::ExecErrorException, BLOCXX_NAMESPACE::FileSystemException, BLOCXX_NAMESPACE::IOException, BLOCXX_NAMESPACE::BadSignatureException, BLOCXX_NAMESPACE::LoggerException, BLOCXX_NAMESPACE::LogMessagePatternFormatterException, BLOCXX_NAMESPACE::MD5Exception, BLOCXX_NAMESPACE::DeadlockException, BLOCXX_NAMESPACE::NULLValueException, BLOCXX_NAMESPACE::NULLReferenceException, BLOCXX_NAMESPACE::RegExCompileException, BLOCXX_NAMESPACE::RegExExecuteException, BLOCXX_NAMESPACE::RWLockerException, 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 241 of file Exception.cpp.

References Exception().

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 70 of file Exception.cpp.

Member Data Documentation

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

Definition at line 103 of file Exception.hpp.

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

Definition at line 104 of file Exception.hpp.

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

Definition at line 160 of file Exception.hpp.

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

int BLOCXX_NAMESPACE::Exception::m_line [private]

Definition at line 161 of file Exception.hpp.

Referenced by getLine(), and swap().

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

Definition at line 162 of file Exception.hpp.

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

int BLOCXX_NAMESPACE::Exception::m_subClassId [private]

Definition at line 163 of file Exception.hpp.

Referenced by getSubClassId(), setSubClassId(), and swap().

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

Definition at line 164 of file Exception.hpp.

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

int BLOCXX_NAMESPACE::Exception::m_errorCode [private]

Definition at line 165 of file Exception.hpp.

Referenced by getErrorCode(), setErrorCode(), and swap().

The documentation for this class was generated from the following files:
Generated on Fri Sep 21 23:42:36 2007 for blocxx by  doxygen 1.5.3