RetsHttpException Class Reference

RetsHttpException is an implementation of RetsException that is thrown when an Http transport error is seen. More...

#include <librets/RetsHttpException.h>

Inheritance diagram for RetsHttpException:

RetsException

List of all members.

Public Member Functions

 RetsHttpException (int httpResult, std::string meaning)
 Construct the exception with the http code and meaning.
virtual ~RetsHttpException () throw ()
int GetHttpResult () const throw ()
 Return the Http transaction code.
std::string GetMessage () const throw ()
 Return the additional text.
virtual std::string GetName () const throw ()
 Return the name of this exception.
void SetContext (const RetsExceptionContext &context)
RetsExceptionContext GetContext () const throw ()
virtual std::string GetExtendedMessage () const throw ()
 Return the extended error message.
virtual void PrintContextMessage (std::ostream &outputStream) const throw ()
std::string GetContextMessage () const throw ()
virtual void PrintFullReport (std::ostream &outputStream) const throw ()
std::string GetFullReport () const throw ()
virtual const char * what () const throw ()
 Returns the error message as a C-style character string.


Detailed Description

RetsHttpException is an implementation of RetsException that is thrown when an Http transport error is seen.

Constructor & Destructor Documentation

RetsHttpException ( int  httpResult,
std::string  meaning 
)

Construct the exception with the http code and meaning.

Parameters:
httpResult The resulting error code from cURL.
meaning A string containing any additional error information.

virtual ~RetsHttpException (  )  throw () [virtual]


Member Function Documentation

RetsExceptionContext GetContext (  )  const throw () [inherited]

std::string GetContextMessage (  )  const throw () [inherited]

virtual std::string GetExtendedMessage (  )  const throw () [virtual, inherited]

Return the extended error message.

Returns:
The extended merror message.

std::string GetFullReport (  )  const throw () [inherited]

int GetHttpResult (  )  const throw ()

Return the Http transaction code.

Returns:
An integer representation of the code.

std::string GetMessage (  )  const throw () [virtual]

Return the additional text.

Returns:
A string containing the additional text.

Reimplemented from RetsException.

virtual std::string GetName (  )  const throw () [virtual]

Return the name of this exception.

Returns:
Always returns "RetsHttpException".

Reimplemented from RetsException.

virtual void PrintContextMessage ( std::ostream &  outputStream  )  const throw () [virtual, inherited]

virtual void PrintFullReport ( std::ostream &  outputStream  )  const throw () [virtual, inherited]

void SetContext ( const RetsExceptionContext context  )  [inherited]

virtual const char* what (  )  const throw () [virtual, inherited]

Returns the error message as a C-style character string.

Returns:
The C-style error message


Generated by  doxygen