xtd 0.2.0
Loading...
Searching...
No Matches
xtd::diagnostics::console_trace_listener Class Reference
Inheritance diagram for xtd::diagnostics::console_trace_listener:
xtd::diagnostics::ostream_trace_listener xtd::diagnostics::trace_listener xtd::abstract_object xtd::object

Definition

Directs tracing or debugging output to either the standard output or the standard error stream.

Directs tracing or debugging output to either the standard output or the standard error stream.
Definition console_trace_listener.h:28
Directs tracing or debugging output to a std::ostream, such as std::fstream, std::stream....
Definition ostream_trace_listener.h:25
#define core_export_
Define shared library export.
Definition core_export.h:13
Inheritance
xtd::objectxtd::abstract_objectxtd::diagnostics::trace_listenerxtd::diagnostics::ostream_trace_listenerxtd::diagnostics::console_trace_listener
Header
#include <xtd/diagnostics/console_trace_listener>
Namespace
xtd::diagnostics
Library
xtd.core
Examples
The following example shows how to use xtd::diagnostics::console_trace_listener class.
#define DEBUG // Force debug mode even if example is builded in release.
#include <xtd/diagnostics/debug>
#include <xtd/diagnostics/console_trace_listener>
#include <xtd/threading/thread>
#include <memory>
using namespace std;
using namespace xtd;
using namespace xtd::diagnostics;
auto main()->int {
debug::listeners({make_shared<console_trace_listener>()});
for (auto step = 1; step <= 10; step++) {
debug::write_line("working step {}...", step);
}
}
// This code produces the following output :
//
// Begin
// working step 1...
// working step 2...
// working step 3...
// working step 4...
// working step 5...
// working step 6...
// working step 7...
// working step 8...
// working step 9...
// working step 10...
// End
static void indent() noexcept
Increases the current indent_level by one.
static void write_line()
Writes a line terminator to the trace listeners in the listeners collection.
Definition debug.h:370
static listener_collection & listeners() noexcept
Gets the collection of listeners that is monitoring the trace output.
static void unindent() noexcept
Decreases the current indent_level by one.
static void sleep(int32 milliseconds_timeout)
Suspends the current thread for a specified time.
The xtd::diagnostics namespace provides classes that allow you to interact with system processes,...
Definition assert_dialog_result.h:10
The xtd namespace contains all fundamental classes to access Hardware, Os, System,...
Definition xtd_about_box.h:10

Public Constructors

 console_trace_listener ()
 Initializes a new instance of the xtd::diagnostics::console_trace_listener class with trace output written to the standard output stream.
 
 console_trace_listener (bool use_error_stream)
 Initializes a new instance of the xtd::diagnostics::console_trace_listener class with an option to write trace output to the standard output stream or the standard error stream.
 

Additional Inherited Members

- Public Member Functions inherited from xtd::diagnostics::ostream_trace_listener
 ostream_trace_listener (const std::ostream &ostream)
 Initializes a new instance of the xtd::diagnostics::ostream_trace_listener class with a specified ostream.
 
virtual const std::ostream & ostream () const
 Gets the underlying stream.
 
virtual void ostream (const std::ostream &ostream)
 Sets the underlying stream.
 
void close () override
 When overridden in a derived class, closes the output stream so it no longer receives tracing or debugging output.
 
void flush () override
 When overridden in a derived class, flushes the output buffer.
 
void write (const xtd::ustring &message) override
 Writes the message to the listener you create when you implement the trace_listener class.
 
void write_line (const xtd::ustring &message) override
 Writes the message to the listener you create when you implement the trace_listener class followed by a line terminator.followed by a line terminator.
 
- Public Member Functions inherited from xtd::diagnostics::trace_listener
 trace_listener ()=default
 Initializes a new instance of the trace_listener class.
 
 trace_listener (const xtd::ustring &name)
 Initializes a new instance of the trace_listener class using the specified name as the listener.
 
uint32 indent_level () const noexcept
 Gets the indent level.
 
void indent_level (uint32 indent_level) noexcept
 Sets the indent level.
 
uint32 indent_size () const noexcept
 Gets the number of spaces in an indent.
 
void indent_size (uint32 indent_size) noexcept
 Sets the number of spaces in an indent.
 
virtual bool is_thread_safe () const noexcept
 Gets a value indicating whether the trace listener is thread safe.
 
const xtd::ustringname () const noexcept
 Gets or sets a name for this TraceListener.
 
void name (const xtd::ustring &name) noexcept
 Sets a name for this TraceListener.
 
trace_options trace_output_options () const noexcept
 Gets the trace output options.
 
void trace_output_options (trace_options trace_output_options) noexcept
 Sets the trace output options.
 
virtual void fail (const xtd::ustring &message)
 Emits an error message to the listener you create when you implement the TraceListener class.
 
virtual void fail (const xtd::ustring &message, const xtd::ustring &detail_message)
 Emits the specified error message.
 
template<typename object >
void trace_data (const xtd::diagnostics::trace_event_cache &event_cache, const xtd::ustring &source, const xtd::diagnostics::trace_event_type &event_type, int32 id, const object &data)
 Writes trace information, a data object and event information to the listener specific output.
 
template<typename object >
void trace_data (const xtd::diagnostics::trace_event_cache &event_cache, const xtd::ustring &source, const xtd::diagnostics::trace_event_type &event_type, int32 id, const std::vector< object > &data)
 Writes trace information, a data object and event information to the listener specific output.
 
template<typename ... objects>
void trace_data (const xtd::diagnostics::trace_event_cache &event_cache, const xtd::ustring &source, const xtd::diagnostics::trace_event_type &event_type, int32 id, const objects &... data)
 Writes trace information, an array of data objects and event information to the listener specific output.
 
virtual void trace_event (const xtd::diagnostics::trace_event_cache &event_cache, const xtd::ustring &source, const xtd::diagnostics::trace_event_type &event_type, int32 id)
 Writes trace and event information to the listener specific output.
 
virtual void trace_event (const xtd::diagnostics::trace_event_cache &event_cache, const xtd::ustring &source, const xtd::diagnostics::trace_event_type &event_type, int32 id, const xtd::ustring &message)
 Writes trace information, a message, and event information to the listener specific output.
 
template<typename ... objects>
void trace_event (const xtd::diagnostics::trace_event_cache &event_cache, const xtd::ustring &source, const xtd::diagnostics::trace_event_type &event_type, int32 id, const xtd::ustring &format, const objects &... args)
 Writes trace information, a formatted array of objects and event information to the listener specific output.
 
template<typename activity_id_type >
void trace_transfer (const xtd::diagnostics::trace_event_cache &event_cache, const xtd::ustring &source, int32 id, const xtd::ustring &message, const activity_id_type &related_activity_id)
 Writes trace information, a message, a related activity identity and event information to the listener specific output.
 
template<typename object >
void write (const object &o)
 Writes the value of the object's ToString method to the listener you create when you implement the TraceListener class.
 
template<typename object >
void write (const object &o, const xtd::ustring &category)
 Writes a category name and the value of the object's ToString method to the listener you create when you implement the TraceListener class.
 
template<typename object >
void write_line (const object &o)
 Writes the value of the object's ToString method to the listener you create when you implement the TraceListener class.
 
template<typename object >
void write_line (const object &o, const xtd::ustring &category)
 Writes a category name and the value of the object's ToString method to the listener you create when you implement the TraceListener class.
 
- Public Member Functions inherited from xtd::object
 object ()=default
 Create a new instance of the ultimate base class object.
 
bool equals (const object &obj) const noexcept
 Determines whether the specified object is equal to the current object.
 
virtual size_t get_hash_code () const noexcept
 Serves as a hash function for a particular type.
 
virtual type_object get_type () const noexcept
 Gets the type of the current instance.
 
template<typename object_t >
std::unique_ptr< object_t > memberwise_clone () const noexcept
 Creates a shallow copy of the current object.
 
virtual xtd::ustring to_string () const noexcept
 Returns a sxd::ustring that represents the current object.
 
- Static Public Member Functions inherited from xtd::object
static bool equals (const object &object_a, const object &object_b) noexcept
 Determines whether the specified object instances are considered equal.
 
static bool reference_equals (const object &object_a, const object &object_b) noexcept
 Determines whether the specified object instances are the same instance.
 
- Protected Member Functions inherited from xtd::diagnostics::trace_listener
bool need_indent () const noexcept
 Gets a value indicating whether to indent the output.
 
void need_indent (bool need_indent) noexcept
 Sets a value indicating whether to indent the output.
 
void thread_safe (bool thread_safe) noexcept
 Sets a value indicating whether the trace listener is thread safe.
 
virtual void write_indent ()
 Writes the indent to the listener you create when you implement this class, and resets the NeedIndent property to false.
 
- Protected Member Functions inherited from xtd::abstract_object
 abstract_object ()=default
 Initializes a new instance of the xtd::abstract_object class.
 

Constructor & Destructor Documentation

◆ console_trace_listener() [1/2]

xtd::diagnostics::console_trace_listener::console_trace_listener ( )

Initializes a new instance of the xtd::diagnostics::console_trace_listener class with trace output written to the standard output stream.

Remarks
This constructor initializes a xtd::diagnostics::console_trace_listener object to write messages to either the std::cout or the std::cerr stream. Its xtd::diagnostics:console_trace_listener::name property is initialized to an empty string ("").

◆ console_trace_listener() [2/2]

xtd::diagnostics::console_trace_listener::console_trace_listener ( bool  use_error_stream)
explicit

Initializes a new instance of the xtd::diagnostics::console_trace_listener class with an option to write trace output to the standard output stream or the standard error stream.

Parameters
use_error_streamtrue to write tracing and debugging output to the standard error stream; false to write tracing and debugging output to the standard output stream.
Remarks
This constructor initializes a xtd::diagnostics::console_trace_listener object to write messages to either the std::cout or the std::cerr stream. Its xtd::diagnostics::console_trace_listener::name property is initialized to an empty string ("").

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