Boost  v1.57.0
doxygen for www.boost.org
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
boost::sinks::basic_debug_output_backend< CharT > Class Template Reference

An implementation of a logging sink backend that outputs to the debugger. More...

#include <debug_output_backend.hpp>

Inheritance diagram for boost::sinks::basic_debug_output_backend< CharT >:
Collaboration diagram for boost::sinks::basic_debug_output_backend< CharT >:

Public Types

typedef base_type::char_type char_type
 Character type. More...
 
typedef base_type::string_type string_type
 String type to be used as a message text holder. More...
 
typedef
base_type::frontend_requirements 
frontend_requirements
 Frontend requirements. More...
 

Public Member Functions

BOOST_LOG_API basic_debug_output_backend ()
 Constructor. More...
 
BOOST_LOG_API ~basic_debug_output_backend ()
 Destructor. More...
 
BOOST_LOG_API void consume (record_view const &rec, string_type const &formatted_message)
 The method passes the formatted message to debugger. More...
 

Detailed Description

template<typename CharT>
class boost::sinks::basic_debug_output_backend< CharT >

An implementation of a logging sink backend that outputs to the debugger.

The sink uses Windows API in order to write log records as debug messages, if the application process is run under debugger. The sink backend also provides a specific filter that allows to check whether the debugger is available and thus elide unnecessary formatting.

Member Typedef Documentation

template<typename CharT >
typedef base_type::char_type boost::sinks::basic_debug_output_backend< CharT >::char_type

Character type.

String type to be used as a message text holder.

Constructor & Destructor Documentation

template<typename CharT >
BOOST_LOG_API boost::sinks::basic_debug_output_backend< CharT >::basic_debug_output_backend ( )

Constructor.

Initializes the sink backend.

template<typename CharT >
BOOST_LOG_API boost::sinks::basic_debug_output_backend< CharT >::~basic_debug_output_backend ( )

Destructor.

Member Function Documentation

template<typename CharT >
BOOST_LOG_API void boost::sinks::basic_debug_output_backend< CharT >::consume ( record_view const &  rec,
string_type const &  formatted_message 
)

The method passes the formatted message to debugger.


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