xtd::diagnostics::source_filter Class Reference

Inheritance diagram for xtd::diagnostics::source_filter:

Definition

Indicates whether a listener should trace a message based on the source of a trace.

class core_export_ source_filter : public xtd::diagnostics::trace_filter

Inheritance

xtd::object → xtd::abstract_object → xtd::diagnostics::trace_filter → xtd::diagnostics::source_filter

Header

#include <xtd/diagnostics/source_filter> 

Namespace

xtd::diagnostics

Library

xtd.core

Remarks

One of several different types of filters can be assigned to a trace listener to provide a layer of screening beyond that provided by the trace switch. The filter can be used to control the level of tracing that is produced by the listener.

This class filters events based on a specific trace source set by the user.

xtd::diagnostics::source_filter overrides the xtd::diagnostics::source_filter::should_trace method and defines a xtd::diagnostics::source_filter::source property that specifies the name of the trace source to be traced by the listener.

Note

This filter is provided because multiple trace sources can simultaneously use the same trace listener.

Public Constructors
	source_filter (const xtd::ustring &source)
	Initializes a new instance of the xtd::diagnostics::source_filter class, specifying the name of the trace source.

Public Properties
const xtd::ustring &	source () const noexcept
	Gets the name of the trace source.
void	source (const xtd::ustring &source) noexcept
	Gets the name of the trace source.

Public Methods
bool	should_trace (const xtd::diagnostics::trace_event_cache &cache, const xtd::ustring &source, xtd::diagnostics::trace_event_type event_type, int32 id, const xtd::ustring &message, std::any data1, const std::vector< std::any > &data_array) noexcept override
	Determines whether the trace listener should trace the event.

Additional Inherited Members
Public Member Functions inherited from xtd::diagnostics::trace_filter
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_filter
	trace_filter ()=default
	Initializes a new instance of the trace_filter class.
bool	should_trace (const xtd::diagnostics::trace_event_cache &cache, const xtd::ustring &source, xtd::diagnostics::trace_event_type event_type, int32 id, const xtd::ustring &message) noexcept
	determines whether the trace listener should trace the event.
bool	should_trace (const xtd::diagnostics::trace_event_cache &cache, const xtd::ustring &source, xtd::diagnostics::trace_event_type event_type, int32 id, const xtd::ustring &message, std::any data1) noexcept
	determines whether the trace listener should trace the event.
Protected Member Functions inherited from xtd::abstract_object
	abstract_object ()=default
	Initializes a new instance of the xtd::abstract_object class.

Constructor & Destructor Documentation

source_filter()

xtd::diagnostics::source_filter::source_filter ( const xtd::ustring &  source )

explicit

Initializes a new instance of the xtd::diagnostics::source_filter class, specifying the name of the trace source.

Parameters

source

The name of the trace source.

Member Function Documentation

should_trace()

bool xtd::diagnostics::source_filter::should_trace ( const xtd::diagnostics::trace_event_cache &  cache, const xtd::ustring &  source, xtd::diagnostics::trace_event_type  event_type, int32  id, const xtd::ustring &  message, std::any  data1, const std::vector< std::any > &  data_array  )

overridevirtualnoexcept

Determines whether the trace listener should trace the event.

Parameters

cache	The trace_event_cache that contains information for the trace event.
source	The name of the source.
event_type	One of the trace_event_type values specifying the type of event that has caused the trace
id	A trace identifier number.
message	Message to write.
data1	A trace data object.
data_array	A trace data object.

Implements xtd::diagnostics::trace_filter.

source() [1/2]

const xtd::ustring & xtd::diagnostics::source_filter::source ( ) const

noexcept

Gets the name of the trace source.

Returns

The name of the trace source.

source() [2/2]

void xtd::diagnostics::source_filter::source ( const xtd::ustring &  source )

noexcept

Gets the name of the trace source.

Parameters

source

The name of the trace source.

---

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

• xtd.core/include/xtd/diagnostics/source_filter.h