BESTimeoutError Class Reference

error thrown if there is a user syntax error in the request or any other user error More...

#include <BESTimeoutError.h>

Inheritance diagram for BESTimeoutError:

Collaboration diagram for BESTimeoutError:

Public Member Functions
virtual void	add_my_error_details_to (BESInfo &) const
	BESTimeoutError (std::string s, std::string file, unsigned int line)
void	dump (std::ostream &strm) const override
	Displays debug information about this object.
std::string	error_name () const override
unsigned int	get_bes_error_type () const
	Return the return code for this error class.
std::string	get_file () const
	get the file name where the exception was thrown
unsigned int	get_line () const
	get the line number where the exception was thrown
std::string	get_message () const
	get the error message for this exception
virtual std::string	get_verbose_message () const
void	set_bes_error_type (unsigned int type)
	Set the return code for this particular error class.
void	set_message (const std::string &msg)
	set the error message for this exception
const char *	what () const noexcept override
	Return a brief message about the exception.

Detailed Description

error thrown if there is a user syntax error in the request or any other user error

Definition at line 41 of file BESTimeoutError.h.

Constructor & Destructor Documentation

BESTimeoutError()

BESTimeoutError::BESTimeoutError ( std::string s, std::string file, unsigned int line )

inline

Definition at line 44 of file BESTimeoutError.h.

Member Function Documentation

add_my_error_details_to()

virtual void BESError::add_my_error_details_to ( BESInfo & ) const

inlinevirtualinherited

Used to add error specific details to the BESInfo object

Parameters

info

Reimplemented in http::HttpError.

Definition at line 116 of file BESError.h.

dump()

void BESTimeoutError::dump ( std::ostream & strm ) const

inlineoverridevirtual

Displays debug information about this object.

dumps information about this object

Parameters

strm	output stream to use to dump the contents of this object

Displays the pointer value of this instance along with the exception message, the file from which the exception was generated, and the line number in that file.

Parameters

strm	C++ i/o stream to dump the information to

Reimplemented from BESError.

Definition at line 49 of file BESTimeoutError.h.

error_name()

std::string BESTimeoutError::error_name ( ) const

inlineoverridevirtual

Reimplemented from BESError.

Definition at line 56 of file BESTimeoutError.h.

get_bes_error_type()

unsigned int BESError::get_bes_error_type ( ) const

inlineinherited

Return the return code for this error class.

Returns the return code for this error class, which could represent the need to terminate or do something specific base on the error

Returns

context string

Definition at line 174 of file BESError.h.

get_file()

std::string BESError::get_file ( ) const

inlineinherited

get the file name where the exception was thrown

Returns

file name

Definition at line 140 of file BESError.h.

get_line()

unsigned int BESError::get_line ( ) const

inlineinherited

get the line number where the exception was thrown

Returns

line number

Definition at line 148 of file BESError.h.

get_message()

std::string BESError::get_message ( ) const

inlineinherited

get the error message for this exception

Returns

error message

Definition at line 132 of file BESError.h.

get_verbose_message()

string BESError::get_verbose_message ( ) const

virtualinherited

Definition at line 43 of file BESError.cc.

set_bes_error_type()

void BESError::set_bes_error_type ( unsigned int type )

inlineinherited

Set the return code for this particular error class.

Sets the return code for this error class, which could represent the need to terminate or do something specific based on the error.

Parameters

type	the type of error this error object represents. Can be one of BES_INTERNAL_ERROR, BES_INTERNAL_FATAL_ERROR, BES_SYNTAX_USER_ERROR, BES_FORBIDDEN_ERROR, BES_NOT_FOUND_ERROR

Definition at line 164 of file BESError.h.

set_message()

void BESError::set_message ( const std::string & msg )

inlineinherited

set the error message for this exception

Parameters

msg	message string

Definition at line 108 of file BESError.h.

what()

const char * BESError::what ( ) const

inlineoverridenoexceptinherited

Return a brief message about the exception.

Returns

A char* that points to the message and is valid for the lifetime of this instance.

Definition at line 184 of file BESError.h.

---

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

• BESTimeoutError.h