StreamBase C++ API  10.6.1.0
sb::StreamBaseException Class Reference

The base class for all StreamBaseExceptions. More...

#include <Exceptions.hpp>

Inheritance diagram for sb::StreamBaseException:
sb::ArgumentOutOfRange sb::IllegalArgumentException sb::MalformedURIException sb::NonTupleFieldInPath sb::NoSuchFieldException sb::NullValueException sb::StreamBaseBadEntityException sb::StreamBaseBadXmlException sb::StreamBaseDequeueTimeoutException sb::StreamBaseIllegalArgumentException sb::StreamBaseListException sb::StreamBaseNetworkException sb::StreamBaseNoSuchEntityException sb::StreamBaseNotImplementedException sb::StreamBaseNotSupportedException sb::StreamBaseTimeoutException sb::StreamBaseTypingException sb::StreamBaseXmlRpcFault sb::TimestampException sb::TupleStringParseException

Public Member Functions

 StreamBaseException (std::string code, std::string message, sb_internal::Errors::Type error_type=sb_internal::Errors::UNKNOWNTYPE, std::string type="StreamBaseException")
 Constructor. More...
 
 StreamBaseException (std::string code, std::string message, StreamBaseException &c, sb_internal::Errors::Type error_type=sb_internal::Errors::UNKNOWNTYPE, std::string type="StreamBaseException")
 Constructor. More...
 
virtual ~StreamBaseException () throw ()
 Destructor. More...
 
virtual const char * what () const throw ()
 Returns the message as a C string. More...
 

Protected Member Functions

virtual std::string causeAsXmlString () const
 

Detailed Description

The base class for all StreamBaseExceptions.

Currently defined exceptions include

An StreamBaseException should never be thrown directly; use the Throw macro instead.

Constructor & Destructor Documentation

sb::StreamBaseException::StreamBaseException ( std::string  code,
std::string  message,
sb_internal::Errors::Type  error_type = sb_internal::Errors::UNKNOWNTYPE,
std::string  type = "StreamBaseException" 
)

Constructor.

Parameters
codesee ExceptionsCodes.hpp; use SB_NEW_MESSAGE_CODE if in doubt
messagethe exception message
error_typethe class of error, for server runtime error handling
typethe type of the exception
sb::StreamBaseException::StreamBaseException ( std::string  code,
std::string  message,
StreamBaseException c,
sb_internal::Errors::Type  error_type = sb_internal::Errors::UNKNOWNTYPE,
std::string  type = "StreamBaseException" 
)

Constructor.

Parameters
codesee ExceptionsCodes.hpp; use SB_NEW_MESSAGE_CODE if in doubt
messagethe exception message
can exception that is the "cause" of this exception
error_typethe class of error, for server runtime error handling
typethe type of the exception
virtual sb::StreamBaseException::~StreamBaseException ( ) throw ()
virtual

Destructor.

Member Function Documentation

virtual const char* sb::StreamBaseException::what ( ) const throw ()
inlinevirtual

Returns the message as a C string.

The string is owned by this object, so the pointer becomes invalid upon destruction of the StreamBaseException.


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