dodo  0.0.1
A C++ library to create containerized Linux services
dodo::common::DebugObject Class Reference

Interface to objects that support dumping their state to a string. More...

#include <exception.hpp>

Inheritance diagram for dodo::common::DebugObject:

Public Member Functions

 DebugObject ()
 Default constructor does nothing. More...
 
virtual ~DebugObject ()
 Destructor does nothing. More...
 
std::string debugString () const
 Return the object dump to string. More...
 

Protected Member Functions

virtual std::string debugDetail () const
 Descendant classes can override to dump details specific to the class. More...
 
std::string debugHeader () const
 Generates a debug header (address of this object and a demangled class name. More...
 

Detailed Description

Interface to objects that support dumping their state to a string.

Definition at line 39 of file exception.hpp.

Constructor & Destructor Documentation

◆ DebugObject()

dodo::common::DebugObject::DebugObject ( )
inline

Default constructor does nothing.

Definition at line 45 of file exception.hpp.

◆ ~DebugObject()

virtual dodo::common::DebugObject::~DebugObject ( )
inlinevirtual

Destructor does nothing.

Definition at line 50 of file exception.hpp.

Member Function Documentation

◆ debugDetail()

virtual std::string dodo::common::DebugObject::debugDetail ( ) const
inlineprotectedvirtual

Descendant classes can override to dump details specific to the class.

By default, returns nothing.

Returns
The string.

Reimplemented in dodo::network::BaseSocket.

Definition at line 66 of file exception.hpp.

Referenced by debugString().

Here is the caller graph for this function:

◆ debugHeader()

std::string dodo::common::DebugObject::debugHeader ( ) const
protected

Generates a debug header (address of this object and a demangled class name.

Returns
The string.

Definition at line 39 of file exception.cpp.

Referenced by debugString().

Here is the caller graph for this function:

◆ debugString()

std::string dodo::common::DebugObject::debugString ( ) const

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