Exception.hpp File Reference

#include "blocxx/BLOCXX_config.h"
#include "blocxx/AutoPtr.hpp"
#include <iosfwd>
#include <exception>
#include <new>
#include <cerrno>

Go to the source code of this file.

Classes

class  BLOCXX_NAMESPACE::Exception
 This class is the base of all exceptions thrown by BloCxx code. More...
class  BLOCXX_NAMESPACE::ExceptionDetail::FormatMsg
struct  BLOCXX_NAMESPACE::ExceptionDetail::Errno< exType >

Namespaces

namespace  BLOCXX_NAMESPACE
 

Taken from RFC 1321.


namespace  BLOCXX_NAMESPACE::ExceptionDetail

Defines

#define BLOCXX_THROW(exType, msg)   throw exType(__FILE__, __LINE__, (msg))
 Throw an exception using __FILE__ and __LINE__.
#define BLOCXX_THROWL(exType, line, msg)   throw exType(__FILE__, (line), (msg))
 This macro is deprecated in 3.1.0.
#define BLOCXX_THROW_SUBEX(exType, msg, subex)
 Throw an exception using __FILE__ and __LINE__.
#define BLOCXX_THROW_ERR(exType, msg, err)   throw exType(__FILE__, __LINE__, (msg), (err))
 Throw an exception using __FILE__ and __LINE__.
#define BLOCXX_THROW_ERRNO(exType)   BLOCXX_THROW_ERRNO1(exType, errno)
 Throw an exception using __FILE__, __LINE__, errno and strerror(errno).
#define BLOCXX_THROW_ERRNO1(exType, errnum)   throw ::BLOCXX_NAMESPACE::ExceptionDetail::Errno< exType >::simple(__FILE__, __LINE__, (errnum))
 Throw an exception using __FILE__, __LINE__, errnum and strerror(errnum).
#define BLOCXX_THROW_ERRNO_MSG(exType, msg)   BLOCXX_THROW_ERRNO_MSG1(exType, (msg), errno)
 Throw an exception using __FILE__, __LINE__, errno and strerror(errno).
#define BLOCXX_THROW_ERRNO_MSG1(exType, msg, errnum)
 Throw an exception using __FILE__, __LINE__, errnum and strerror(errnum).
#define BLOCXX_THROW_ERR_SUBEX(exType, msg, err, subex)   throw exType(__FILE__, __LINE__, (msg), (err), &(subex))
 Throw an exception using __FILE__ and __LINE__.
#define BLOCXX_DECLARE_EXCEPTION2(NAME, BASE)
 Declare a new exception class named <NAME>Exception that derives from <BASE>.
#define BLOCXX_DECLARE_APIEXCEPTION2(NAME, BASE, LINKAGE_SPEC)
 Declare a new exception class named <NAME>Exception that derives from <BASE>.
#define BLOCXX_DECLARE_EXCEPTION(NAME)   BLOCXX_DECLARE_EXCEPTION2(NAME, ::BLOCXX_NAMESPACE::Exception)
 Declare a new exception class named <NAME>Exception that derives from Exception This macro is typically used in a header file.
#define BLOCXX_DECLARE_APIEXCEPTION(NAME, LINKAGE_SPEC)   BLOCXX_DECLARE_APIEXCEPTION2(NAME, ::BLOCXX_NAMESPACE::Exception, LINKAGE_SPEC)
 Declare a new exception class named <NAME>Exception that derives from Exception This macro is typically used in a header file.
#define BLOCXX_DEFINE_EXCEPTION2(NAME, BASE)
 Define a new exception class named <NAME>Exception that derives from <BASE>.
#define BLOCXX_DEFINE_EXCEPTION_WITH_BASE_AND_ID_AUX(NAME, BASE, SUB_CLASS_ID)
 Define a new exception class named <NAME>Exception that derives from <BASE>.
#define BLOCXX_DEFINE_EXCEPTION(NAME)   BLOCXX_DEFINE_EXCEPTION_WITH_BASE_AND_ID_AUX(NAME, ::BLOCXX_NAMESPACE::Exception, ::BLOCXX_NAMESPACE::Exception::UNKNOWN_SUBCLASS_ID)
 Define a new exception class named <NAME>Exception that derives from Exception.
#define BLOCXX_DEFINE_EXCEPTION_WITH_ID(NAME)   BLOCXX_DEFINE_EXCEPTION_WITH_BASE_AND_ID_AUX(NAME, ::BLOCXX_NAMESPACE::Exception, ::BLOCXX_NAMESPACE::ExceptionIds::NAME##ExceptionId)
 Define a new exception class named <NAME>Exception that derives from Exception.
#define BLOCXX_DEFINE_EXCEPTION_WITH_BASE_AND_ID(NAME, BASE)   BLOCXX_DEFINE_EXCEPTION_WITH_BASE_AND_ID_AUX(NAME, BASE, ::BLOCXX_NAMESPACE::ExceptionIds::NAME##ExceptionId)
 Define a new exception class named <NAME>Exception that derives from <BASE>.

Functions

void BLOCXX_NAMESPACE::ExceptionDetail::portable_strerror_r (int errnum, char *buf, unsigned n)
std::ostream & BLOCXX_NAMESPACE::operator<< (std::ostream &os, const Exception &e)
 Writes the exception object to the stream in the form: <file>: <line> <type>: <message>

Variables

struct BLOCXX_COMMON_API BLOCXX_NAMESPACE::ExceptionDetail::FormatMsgImpl
unsigned const BLOCXX_NAMESPACE::ExceptionDetail::BUFSZ = 1024

Define Documentation

#define BLOCXX_DECLARE_APIEXCEPTION ( NAME,
LINKAGE_SPEC   )     BLOCXX_DECLARE_APIEXCEPTION2(NAME, ::BLOCXX_NAMESPACE::Exception, LINKAGE_SPEC)

Declare a new exception class named <NAME>Exception that derives from Exception This macro is typically used in a header file.

Parameters:
NAME The name of the new class (Exception will be postfixed)
LINKAGE_SPEC the linkage specifier. If the BLOCXX_DEFINE_EXCEPTION is part of libblocxx this would BLOCXX_COMMON_API...

Definition at line 396 of file Exception.hpp.

#define BLOCXX_DECLARE_APIEXCEPTION2 ( NAME,
BASE,
LINKAGE_SPEC   ) 
Value:
class LINKAGE_SPEC NAME##Exception : public BASE \
{ \
public: \
   NAME##Exception(const char* file, int line, const char* msg, int errorCode = ::BLOCXX_NAMESPACE::Exception::UNKNOWN_ERROR_CODE, const Exception* otherException = 0, int subClassId = ::BLOCXX_NAMESPACE::Exception::UNKNOWN_SUBCLASS_ID); \
   virtual ~NAME##Exception() throw(); \
   virtual const char* type() const; \
   virtual NAME##Exception* clone() const; \
   virtual void rethrow() const; \
};

Declare a new exception class named <NAME>Exception that derives from <BASE>.

This macro is typically used in a header file. The exception class declaration will be prefaced with the linkage_spec parm. This allows the use of BLOCXX_COMMON_API when declaring exceptions. Example: BLOCXX_DECLARE_APIEXCEPTION(Bogus, MYException, BLOCXX_COMMON_API)

Parameters:
NAME The name of the new class (Exception will be postfixed)
BASE The base class.
LINKAGE_SPEC The linkage specifier for the exception class.

Definition at line 366 of file Exception.hpp.

#define BLOCXX_DECLARE_EXCEPTION ( NAME   )     BLOCXX_DECLARE_EXCEPTION2(NAME, ::BLOCXX_NAMESPACE::Exception)

Declare a new exception class named <NAME>Exception that derives from Exception This macro is typically used in a header file.

Parameters:
NAME The name of the new class (Exception will be postfixed)

Definition at line 386 of file Exception.hpp.

#define BLOCXX_DECLARE_EXCEPTION2 ( NAME,
BASE   ) 
Value:
class NAME##Exception : public BASE \
{ \
public: \
   NAME##Exception(const char* file, int line, const char* msg, int errorCode = ::BLOCXX_NAMESPACE::Exception::UNKNOWN_ERROR_CODE, const Exception* otherException = 0, int subClassId = ::BLOCXX_NAMESPACE::Exception::UNKNOWN_SUBCLASS_ID); \
   virtual ~NAME##Exception() throw(); \
   virtual const char* type() const; \
   virtual NAME##Exception* clone() const; \
   virtual void rethrow() const; \
};

Declare a new exception class named <NAME>Exception that derives from <BASE>.

This macro is typically used in a header file.

Parameters:
NAME The name of the new class (Exception will be postfixed)
BASE The base class.

Definition at line 344 of file Exception.hpp.

#define BLOCXX_DEFINE_EXCEPTION ( NAME   )     BLOCXX_DEFINE_EXCEPTION_WITH_BASE_AND_ID_AUX(NAME, ::BLOCXX_NAMESPACE::Exception, ::BLOCXX_NAMESPACE::Exception::UNKNOWN_SUBCLASS_ID)

Define a new exception class named <NAME>Exception that derives from Exception.

The new class will use UNKNOWN_SUBCLASS_ID for the subclass id. Use this macro for internal implementation exceptions that don't have an id. This macro is typically used in a cpp file.

Parameters:
NAME The name of the new class (Exception will be postfixed)

Definition at line 439 of file Exception.hpp.

#define BLOCXX_DEFINE_EXCEPTION2 ( NAME,
BASE   ) 
Value:
NAME##Exception::NAME##Exception(const char* file, int line, const char* msg, int errorCode, const ::BLOCXX_NAMESPACE::Exception* otherException, int subClassId) \
   : BASE(file, line, msg, errorCode, otherException, subClassId) {} \
NAME##Exception::~NAME##Exception() throw() { } \
NAME##Exception* NAME##Exception::clone() const { return new(std::nothrow) NAME##Exception(*this); } \
const char* NAME##Exception::type() const { return #NAME "Exception"; }\
void NAME##Exception::rethrow() const { throw *this; }

Define a new exception class named <NAME>Exception that derives from <BASE>.

The new class will use UNKNOWN_SUBCLASS_ID for the subclass id. This macro is typically used in a cpp file.

Parameters:
NAME The name of the new class (Exception will be postfixed)
BASE The base class.

Definition at line 406 of file Exception.hpp.

#define BLOCXX_DEFINE_EXCEPTION_WITH_BASE_AND_ID ( NAME,
BASE   )     BLOCXX_DEFINE_EXCEPTION_WITH_BASE_AND_ID_AUX(NAME, BASE, ::BLOCXX_NAMESPACE::ExceptionIds::NAME##ExceptionId)

Define a new exception class named <NAME>Exception that derives from <BASE>.

The new class will use ExceptionIds::<NAME>ExceptionId for the subclass id. Use this macro to create public exceptions that have an id in the BLOCXX_NAMESPACE::ExceptionIds namespace that will derive from BASE This macro is typically used in a cpp file.

Parameters:
NAME The name of the new class (Exception will be postfixed)
BASE The base class.

Definition at line 460 of file Exception.hpp.

#define BLOCXX_DEFINE_EXCEPTION_WITH_BASE_AND_ID_AUX ( NAME,
BASE,
SUB_CLASS_ID   ) 
Value:
NAME##Exception::NAME##Exception(const char* file, int line, const char* msg, int errorCode, const ::BLOCXX_NAMESPACE::Exception* otherException, int subClassId) \
   : BASE(file, line, msg, errorCode, otherException, subClassId == ::BLOCXX_NAMESPACE::Exception::UNKNOWN_SUBCLASS_ID ? (SUB_CLASS_ID) : subClassId) {} \
NAME##Exception::~NAME##Exception() throw() { } \
NAME##Exception* NAME##Exception::clone() const { return new(std::nothrow) NAME##Exception(*this); } \
const char* NAME##Exception::type() const { return #NAME "Exception"; } \
void NAME##Exception::rethrow() const { throw *this; }

Define a new exception class named <NAME>Exception that derives from <BASE>.

The new class will use SUB_CLASS_ID for the subclass id. This macro is typically used in a cpp file.

Parameters:
NAME The name of the new class (Exception will be postfixed)
BASE The base class.
SUB_CLASS_ID The subclass id.

Definition at line 423 of file Exception.hpp.

#define BLOCXX_DEFINE_EXCEPTION_WITH_ID ( NAME   )     BLOCXX_DEFINE_EXCEPTION_WITH_BASE_AND_ID_AUX(NAME, ::BLOCXX_NAMESPACE::Exception, ::BLOCXX_NAMESPACE::ExceptionIds::NAME##ExceptionId)

Define a new exception class named <NAME>Exception that derives from Exception.

The new class will use ExceptionIds::<NAME>ExceptionId for the subclass id. Use this macro to create public exceptions that have an id in the BLOCXX_NAMESPACE::ExceptionIds namespace that derive from Exception This macro is typically used in a cpp file.

Parameters:
NAME The name of the new class (Exception will be postfixed)

Definition at line 449 of file Exception.hpp.

#define BLOCXX_THROW ( exType,
msg   )     throw exType(__FILE__, __LINE__, (msg))

Throw an exception using __FILE__ and __LINE__.

If applicable, BLOCXX_THROW_ERR should be used instead of this macro.

Parameters:
exType The type of the exception
msg The exception message. A string that will be copied.

Definition at line 263 of file Exception.hpp.

Referenced by BLOCXX_NAMESPACE::ServerSocketImpl::accept(), BLOCXX_NAMESPACE::GenericRWLockImpl< IdT, CompareT >::acquireReadLock(), BLOCXX_NAMESPACE::GenericRWLockImpl< IdT, CompareT >::acquireWriteLock(), BLOCXX_NAMESPACE::SocketAddress::allocEmptyAddress(), BLOCXX_NAMESPACE::FileSystemMockObject::basename(), BLOCXX_NAMESPACE::TempFileBuffer::buffer_to_device(), BLOCXX_NAMESPACE::FileSystemMockObject::canRead(), BLOCXX_NAMESPACE::FileSystemMockObject::canWrite(), BLOCXX_NAMESPACE::FileSystemMockObject::changeDirectory(), BLOCXX_NAMESPACE::FileSystemMockObject::changeFileOwner(), BLOCXX_NAMESPACE::FileSystemMockObject::close(), BLOCXX_NAMESPACE::NonRecursiveMutex::conditionPostWait(), BLOCXX_NAMESPACE::SocketBaseImpl::connect(), BLOCXX_NAMESPACE::FileSystemMockObject::createFile(), BLOCXX_NAMESPACE::FileSystemMockObject::createTempFile(), BLOCXX_NAMESPACE::FileSystemMockObject::dirname(), BLOCXX_NAMESPACE::ExecMockObject::executeProcessAndGatherOutput(), BLOCXX_NAMESPACE::ExecMockObject::executeProcessAndGatherOutput2(), BLOCXX_NAMESPACE::FileSystemMockObject::exists(), BLOCXX_NAMESPACE::SafeCString::fget_string(), BLOCXX_NAMESPACE::SafeCString::fgets_check(), BLOCXX_NAMESPACE::FileAppender::FileAppender(), BLOCXX_NAMESPACE::FileSystemMockObject::fileSize(), BLOCXX_NAMESPACE::FileSystemMockObject::flush(), BLOCXX_NAMESPACE::FileSystemMockObject::getCurrentWorkingDirectory(), BLOCXX_NAMESPACE::FileSystemMockObject::getDirectoryContents(), BLOCXX_NAMESPACE::FileSystem::getFileContents(), BLOCXX_NAMESPACE::FileSystemMockObject::getFileContents(), BLOCXX_NAMESPACE::FileSystemMockObject::getFileLines(), BLOCXX_NAMESPACE::FileSystemMockObject::getFileSize(), BLOCXX_NAMESPACE::SocketAddress::getUDS(), BLOCXX_NAMESPACE::PosixUnnamedPipe::getWriteSelectObj(), BLOCXX_NAMESPACE::FileSystemMockObject::isDirectory(), BLOCXX_NAMESPACE::FileSystemMockObject::isExecutable(), BLOCXX_NAMESPACE::FileSystemMockObject::isLink(), BLOCXX_NAMESPACE::DateTime::localTimeAndOffset(), BLOCXX_NAMESPACE::FileSystemMockObject::makeDirectory(), BLOCXX_NAMESPACE::MultiProcessFileAppender::MultiProcessFileAppender(), BLOCXX_NAMESPACE::NwIface::NwIface(), BLOCXX_NAMESPACE::FileSystemMockObject::openForAppendOrCreateFile(), BLOCXX_NAMESPACE::FileSystemMockObject::openOrCreateFile(), BLOCXX_NAMESPACE::FileSystem::read(), BLOCXX_NAMESPACE::FileSystemMockObject::read(), BLOCXX_NAMESPACE::TempFileEnumerationImplBase::readSize(), BLOCXX_NAMESPACE::FileSystemMockObject::readSymbolicLink(), BLOCXX_NAMESPACE::FileSystem::Path::realPath(), BLOCXX_NAMESPACE::FileSystemMockObject::realPath(), BLOCXX_NAMESPACE::GenericRWLockImpl< IdT, CompareT >::releaseReadLock(), BLOCXX_NAMESPACE::GenericRWLockImpl< IdT, CompareT >::releaseWriteLock(), BLOCXX_NAMESPACE::FileSystemMockObject::removeDirectory(), BLOCXX_NAMESPACE::FileSystemMockObject::removeFile(), BLOCXX_NAMESPACE::FileSystemMockObject::renameFile(), BLOCXX_NAMESPACE::FileSystemMockObject::rewind(), BLOCXX_NAMESPACE::FileSystemMockObject::security(), BLOCXX_NAMESPACE::FileSystem::seek(), BLOCXX_NAMESPACE::FileSystemMockObject::seek(), BLOCXX_NAMESPACE::DateTime::set(), BLOCXX_NAMESPACE::ThreadCounter::setMax(), BLOCXX_NAMESPACE::DateTime::setMicrosecond(), BLOCXX_NAMESPACE::DateTime::setMonth(), BLOCXX_NAMESPACE::DateTime::setTime(), BLOCXX_NAMESPACE::Socket::Socket(), BLOCXX_NAMESPACE::SyslogAppender::SyslogAppender(), BLOCXX_NAMESPACE::FileSystemMockObject::tell(), BLOCXX_NAMESPACE::TempFileEnumerationImplBase::TempFileEnumerationImplBase(), BLOCXX_NAMESPACE::TempFileEnumerationImplBase::throwIfEmpty(), BLOCXX_NAMESPACE::throwStringConversion(), BLOCXX_NAMESPACE::Condition::timedWait(), BLOCXX_NAMESPACE::MD5::toString(), BLOCXX_NAMESPACE::FileSystem::write(), BLOCXX_NAMESPACE::FileSystemMockObject::write(), BLOCXX_NAMESPACE::Mutex::~Mutex(), and BLOCXX_NAMESPACE::NonRecursiveMutex::~NonRecursiveMutex().

#define BLOCXX_THROW_ERR ( exType,
msg,
err   )     throw exType(__FILE__, __LINE__, (msg), (err))

Throw an exception using __FILE__ and __LINE__.

Parameters:
exType The type of the exception
msg The exception message. A string that will be copied.
err The error code.

Definition at line 287 of file Exception.hpp.

#define BLOCXX_THROW_ERR_SUBEX ( exType,
msg,
err,
subex   )     throw exType(__FILE__, __LINE__, (msg), (err), &(subex))

Throw an exception using __FILE__ and __LINE__.

Parameters:
exType The type of the exception
msg The exception message. A string that will be copied.
err The error code.
subex A sub-exception. A point to it will be passed to the exception constructor, which should clone() it.

Definition at line 334 of file Exception.hpp.

#define BLOCXX_THROW_ERRNO ( exType   )     BLOCXX_THROW_ERRNO1(exType, errno)

Throw an exception using __FILE__, __LINE__, errno and strerror(errno).

Parameters:
exType The type of the exception; ctor must take file, line, message, and error code.

Definition at line 295 of file Exception.hpp.

Referenced by BLOCXX_NAMESPACE::FileSystem::Path::getCurrentWorkingDirectory().

#define BLOCXX_THROW_ERRNO1 ( exType,
errnum   )     throw ::BLOCXX_NAMESPACE::ExceptionDetail::Errno< exType >::simple(__FILE__, __LINE__, (errnum))

Throw an exception using __FILE__, __LINE__, errnum and strerror(errnum).

Parameters:
exType The type of the exception; ctor must take file, line, message, and error code.
errnum The errno value.

Definition at line 303 of file Exception.hpp.

#define BLOCXX_THROW_ERRNO_MSG ( exType,
msg   )     BLOCXX_THROW_ERRNO_MSG1(exType, (msg), errno)
#define BLOCXX_THROW_ERRNO_MSG1 ( exType,
msg,
errnum   ) 
Value:
throw ::BLOCXX_NAMESPACE::ExceptionDetail::Errno< exType >:: \
      format(__FILE__, __LINE__, (msg), (errnum))

Throw an exception using __FILE__, __LINE__, errnum and strerror(errnum).

Parameters:
exType The type of the exception; ctor must take file, line, message, and error code.
msg The exception message to use.
errnum The errno value.

Definition at line 322 of file Exception.hpp.

#define BLOCXX_THROW_SUBEX ( exType,
msg,
subex   ) 
Value:
throw exType(__FILE__, __LINE__, (msg), \
             ::BLOCXX_NAMESPACE::Exception::UNKNOWN_ERROR_CODE, &(subex))

Throw an exception using __FILE__ and __LINE__.

Parameters:
exType The type of the exception
msg The exception message. A string that will be copied.
subex A sub-exception. A pointer to it will be passed to the exception constructor, which should clone() it.

Definition at line 277 of file Exception.hpp.

Referenced by BLOCXX_NAMESPACE::RWLocker::releaseReadLock(), and BLOCXX_NAMESPACE::RWLocker::releaseWriteLock().

#define BLOCXX_THROWL ( exType,
line,
msg   )     throw exType(__FILE__, (line), (msg))

This macro is deprecated in 3.1.0.

Definition at line 268 of file Exception.hpp.

Generated on Mon Jul 5 19:59:33 2010 for blocxx by  doxygen 1.6.3