kcenon::logger::output_sink_interface Class Reference

Abstract interface for log output destinations (I/O only) More...

#include <output_sink_interface.h>

Inheritance diagram for kcenon::logger::output_sink_interface:

Collaboration diagram for kcenon::logger::output_sink_interface:

Public Member Functions
virtual	~output_sink_interface ()=default
virtual common::VoidResult	write_raw (std::string_view message)=0
	Write a pre-formatted message to the output destination.
virtual common::VoidResult	flush ()=0
	Flush any buffered data.
virtual bool	is_healthy () const =0
	Check if the sink is healthy.
virtual std::string	get_name () const =0
	Get the name of this sink.
virtual std::string	get_info () const
	Get sink information.

Detailed Description

Abstract interface for log output destinations (I/O only)

Defines the contract for outputting pre-formatted log messages. This is separate from log_sink_interface which handles async processing.

Since

1.3.0

Definition at line 40 of file output_sink_interface.h.

Constructor & Destructor Documentation

~output_sink_interface()

virtual kcenon::logger::output_sink_interface::~output_sink_interface ( )

virtualdefault

Member Function Documentation

flush()

virtual common::VoidResult kcenon::logger::output_sink_interface::flush ( )

pure virtual

Flush any buffered data.

Returns

common::VoidResult Success or error code

Implemented in kcenon::logger::console_sink, and kcenon::logger::file_sink.

get_info()

virtual std::string kcenon::logger::output_sink_interface::get_info ( ) const

inlinevirtual

Get sink information.

Returns

Diagnostic string

Reimplemented in kcenon::logger::console_sink, and kcenon::logger::file_sink.

Definition at line 73 of file output_sink_interface.h.

                                       {
        return "";
    }

get_name()

virtual std::string kcenon::logger::output_sink_interface::get_name ( ) const

pure virtual

Get the name of this sink.

Returns

Sink identifier

Implemented in kcenon::logger::console_sink, and kcenon::logger::file_sink.

is_healthy()

virtual bool kcenon::logger::output_sink_interface::is_healthy ( ) const

pure virtual

Check if the sink is healthy.

Returns

true if operational

Implemented in kcenon::logger::console_sink, and kcenon::logger::file_sink.

write_raw()

virtual common::VoidResult kcenon::logger::output_sink_interface::write_raw ( std::string_view message )

pure virtual

Write a pre-formatted message to the output destination.

Parameters

message

Pre-formatted log message

Returns

common::VoidResult Success or error code

Implemented in kcenon::logger::console_sink, and kcenon::logger::file_sink.

---

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

• include/kcenon/logger/interfaces/output_sink_interface.h