fc::exception Class Reference

Used to generate a useful error report when an exception is thrown. More...

#include <exception.hpp>

Inheritance diagram for fc::exception:

Collaboration diagram for fc::exception:

Public Types
enum	code_enum { code_value = unspecified_exception_code }

Public Member Functions
	exception (int64_t code=unspecified_exception_code, const std::string &name_value="exception", const std::string &what_value="unspecified")
	exception (log_message &&, int64_t code=unspecified_exception_code, const std::string &name_value="exception", const std::string &what_value="unspecified")
	exception (log_messages &&, int64_t code=unspecified_exception_code, const std::string &name_value="exception", const std::string &what_value="unspecified")
	exception (const log_messages &, int64_t code=unspecified_exception_code, const std::string &name_value="exception", const std::string &what_value="unspecified")
	exception (const exception &e)
	exception (exception &&e)
virtual	~exception ()
const char *	name () const throw ()
int64_t	code () const throw ()
const char *	what () const noexcept override
const log_messages &	get_log () const
void	append_log (log_message m)
std::string	to_detail_string (log_level ll=log_level::all) const
std::string	to_string (log_level ll=log_level::info) const
std::string	top_message () const
virtual NO_RETURN void	dynamic_rethrow_exception () const
virtual std::shared_ptr< exception >	dynamic_copy_exception () const
exception &	operator= (const exception &copy)
exception &	operator= (exception &&copy)

Static Public Attributes
static constexpr fc::microseconds	format_time_limit = fc::milliseconds( 10 )

Protected Attributes
std::unique_ptr< detail::exception_impl >	my

Friends
void	to_variant (const exception &e, variant &v)
void	from_variant (const variant &e, exception &ll)

Detailed Description

At each level in the stack where the exception is caught and rethrown a new log_message is added to the exception.

exception's are designed to be serialized to a variant and deserialized from an variant.

See also

FC_THROW_EXCEPTION

FC_RETHROW_EXCEPTION

FC_RETHROW_EXCEPTIONS

Definition at line 57 of file exception.hpp.

Member Enumeration Documentation

code_enum

enum fc::exception::code_enum

Enumerator
code_value

Definition at line 62 of file exception.hpp.

         {
            code_value = unspecified_exception_code
         };

Constructor & Destructor Documentation

exception() [1/6]

fc::exception::exception	(	int64_t	code = unspecified_exception_code,
		const std::string &	name_value = "exception",
		const std::string &	what_value = "unspecified" )

Definition at line 93 of file exception.cpp.

   :my( new detail::exception_impl() )
   {
      my->_code = code;
      my->_what = what_value;
      my->_name = name_value;
   }

Here is the call graph for this function:

exception() [2/6]

fc::exception::exception	(	log_message &&	msg,
		int64_t	code = unspecified_exception_code,
		const std::string &	name_value = "exception",
		const std::string &	what_value = "unspecified" )

Definition at line 103 of file exception.cpp.

   :my( new detail::exception_impl() )
   {
      my->_code = code;
      my->_what = what_value;
      my->_name = name_value;
      my->_elog.push_back( fc::move( msg ) );
   }

Here is the call graph for this function:

exception() [3/6]

fc::exception::exception	(	log_messages &&	msgs,
		int64_t	code = unspecified_exception_code,
		const std::string &	name_value = "exception",
		const std::string &	what_value = "unspecified" )

Definition at line 41 of file exception.cpp.

   :my( new detail::exception_impl() )
   {
      my->_code = code;
      my->_what = what_value;
      my->_name = name_value;
      my->_elog = fc::move(msgs);
   }

Here is the call graph for this function:

exception() [4/6]

fc::exception::exception	(	const log_messages &	msgs,
		int64_t	code = unspecified_exception_code,
		const std::string &	name_value = "exception",
		const std::string &	what_value = "unspecified" )

Definition at line 52 of file exception.cpp.

   :my( new detail::exception_impl() )
   {
      my->_code = code;
      my->_what = what_value;
      my->_name = name_value;
      my->_elog = msgs;
   }

Here is the call graph for this function:

exception() [5/6]

fc::exception::exception

(

const exception &

e

)

Definition at line 114 of file exception.cpp.

   :my( new detail::exception_impl(*c.my) )
   { }

exception() [6/6]

fc::exception::exception

(

exception &&

e

)

Definition at line 117 of file exception.cpp.

   :my( fc::move(c.my) ){}

~exception()

fc::exception::~exception ( )

virtual

Definition at line 124 of file exception.cpp.

{}

Member Function Documentation

append_log()

void fc::exception::append_log

(

log_message

m

)

Definition at line 148 of file exception.cpp.

   {
      my->_elog.emplace_back( fc::move(m) );
   }

code()

int64_t fc::exception::code	(		)	const
throw	(	)

Definition at line 122 of file exception.cpp.

{ return my->_code;         }

Here is the caller graph for this function:

dynamic_copy_exception()

exception_ptr fc::exception::dynamic_copy_exception ( ) const

virtual

This is equivalent to:

try { throwAsDynamic_exception(); }
catch( ... ) { return std::current_exception(); }

Reimplemented in fc::std_exception_wrapper, and fc::unhandled_exception.

Definition at line 264 of file exception.cpp.

   {
       return std::make_shared<exception>(*this);
   }

Here is the caller graph for this function:

dynamic_rethrow_exception()

NO_RETURN void fc::exception::dynamic_rethrow_exception ( ) const

virtual

Throw this exception as its most derived type.

Note

does not return.

Rethrows the exception restoring the proper type based upon the error code. This is used to propagate exception types across conversions to/from JSON

Reimplemented in fc::std_exception_wrapper, and fc::unhandled_exception.

Definition at line 259 of file exception.cpp.

   {
      exception_factory::instance().rethrow( *this );
   }

Here is the call graph for this function:

Here is the caller graph for this function:

get_log()

const log_messages & fc::exception::get_log

(

)

const

Returns

a reference to log messages that have been added to this log.

Definition at line 147 of file exception.cpp.

{ return my->_elog; }

Here is the caller graph for this function:

name()

const char * fc::exception::name	(		)	const
throw	(	)

Definition at line 120 of file exception.cpp.

{ return my->_name.c_str(); }

Here is the caller graph for this function:

operator=() [1/2]

exception & fc::exception::operator=

(

const exception &

copy

)

Definition at line 293 of file exception.cpp.

   {
      *my = *copy.my;
      return *this;
   }

Here is the call graph for this function:

operator=() [2/2]

exception & fc::exception::operator=

(

exception &&

copy

)

Definition at line 299 of file exception.cpp.

   {
      my = std::move(copy.my);
      return *this;
   }

Here is the call graph for this function:

to_detail_string()

string fc::exception::to_detail_string

(

log_level

ll = log_level::all

)

const

Generates a detailed string including file, line, method, and other information that is generally only useful for developers.

Definition at line 158 of file exception.cpp.

   {
      const auto deadline = fc::time_point::now() + format_time_limit;
      std::stringstream ss;
      try {
         try {
            ss << variant( my->_code ).as_string();
         } catch( std::bad_alloc& ) {
            throw;
         } catch( ... ) {
            ss << "<- exception in to_detail_string.";
         }
         ss << " " << my->_name << ": " << my->_what << "\n";
         for( auto itr = my->_elog.begin(); itr != my->_elog.end(); ++itr ) {
            try {
               ss << itr->get_message() << "\n"; //fc::format_string( itr->get_format(), itr->get_data() ) <<"\n";
               ss << "    " << json::to_string( itr->get_data(), deadline ) << "\n";
               ss << "    " << itr->get_context().to_string() << "\n";
            } catch( std::bad_alloc& ) {
               throw;
            } catch( const fc::timeout_exception& e) {
               ss << "<- timeout exception in to_detail_string: " << e.what() << "\n";
               break;
            } catch( ... ) {
               ss << "<- exception in to_detail_string.\n";
            }
         }
      } catch( std::bad_alloc& ) {
         throw;
      } catch( ... ) {
         ss << "<- exception in to_detail_string.\n";
      }
      return ss.str();
   }

Here is the call graph for this function:

Here is the caller graph for this function:

to_string()

string fc::exception::to_string

(

log_level

ll = log_level::info

)

const

Generates a user-friendly error report.

Definition at line 196 of file exception.cpp.

   {
      const auto deadline = fc::time_point::now() + format_time_limit;
      std::stringstream ss;
      try {
         ss << my->_what;
         try {
            ss << " (" << variant( my->_code ).as_string() << ")\n";
         } catch( std::bad_alloc& ) {
            throw;
         } catch( ... ) {
            ss << "<- exception in to_string.\n";
         }
         for( auto itr = my->_elog.begin(); itr != my->_elog.end(); ++itr ) {
            try {
               FC_CHECK_DEADLINE(deadline);
               ss << fc::format_string( itr->get_format(), itr->get_data(), true) << "\n";
               //      ss << "    " << itr->get_context().to_string() <<"\n";
            } catch( std::bad_alloc& ) {
               throw;
            } catch( const fc::timeout_exception& e) {
               ss << "<- timeout exception in to_string: " << e.what();
               break;
            } catch( ... ) {
               ss << "<- exception in to_string.\n";
            }
         }
         return ss.str();
      } catch( std::bad_alloc& ) {
         throw;
      } catch( ... ) {
         ss << "<- exception in to_string.\n";
      }
      return ss.str();
   }

Here is the call graph for this function:

Here is the caller graph for this function:

top_message()

string fc::exception::top_message

(

)

const

Generates a user-friendly error report.

Definition at line 235 of file exception.cpp.

   {
      for( auto itr = my->_elog.begin(); itr != my->_elog.end(); ++itr )
      {
         auto s = fc::format_string( itr->get_format(), itr->get_data() );
         if (!s.empty()) {
            return s;
         }
      }
      return string();
   }

Here is the call graph for this function:

Here is the caller graph for this function:

what()

const char * fc::exception::what ( ) const

overridenoexcept

Definition at line 121 of file exception.cpp.

{ return my->_what.c_str(); }

Here is the caller graph for this function:

Friends And Related Symbol Documentation

from_variant

void from_variant ( const variant & e, exception & ll )

friend

Definition at line 134 of file exception.cpp.

   {
      auto obj = v.get_object();
      if( obj.contains( "stack" ) )
         ll.my->_elog =  obj["stack"].as<log_messages>();
      if( obj.contains( "code" ) )
         ll.my->_code = obj["code"].as_int64();
      if( obj.contains( "name" ) )
         ll.my->_name = obj["name"].as_string();
      if( obj.contains( "message" ) )
         ll.my->_what = obj["message"].as_string();
   }

to_variant

void to_variant ( const exception & e, variant & v )

friend

Definition at line 126 of file exception.cpp.

   {
      v = mutable_variant_object( "code", e.code() )
                                ( "name", e.name() )
                                ( "message", e.what() )
                                ( "stack", e.get_log() );
 
   }

Member Data Documentation

format_time_limit

fc::microseconds fc::exception::format_time_limit = fc::milliseconds( 10 )

staticconstexpr

Definition at line 60 of file exception.hpp.

my

std::unique_ptr<detail::exception_impl> fc::exception::my

protected

Definition at line 134 of file exception.hpp.

---

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

• libraries/fc/include/fc/exception/exception.hpp
• libraries/fc/src/exception.cpp