High-performance file logger based on memory-mapped I/O. More...
#include <file_logger_stream_mapping.h>
Inheritance diagram for qx::file_logger_stream_mapping:
Public Member Functions | |
| file_logger_stream_mapping (const config &streamConfig=config(), unit< size_t, units::data > initialMapSize={ 1, units::data::mebibytes }) noexcept | |
| file_logger_stream_mapping object constructor More... | |
| virtual void | do_log (const category &category, verbosity eVerbosity, std::thread::id threadId, std::chrono::system_clock::time_point messageTime, string_view svFile, string_view svFunction, int nLine, string_view svMessage) override |
| Proceed stream logging. More... | |
| virtual void | do_flush () override |
| Flush the stream. | |
 Public Member Functions inherited from qx::base_file_logger_stream | |
| base_file_logger_stream (const config &streamConfig) noexcept | |
| file_logger_stream object constructor More... | |
| Public Member Functions inherited from qx::base_logger_stream | |
| base_logger_stream (const config &streamConfig) noexcept | |
| base_logger_stream object constructor More... | |
| compile_pattern_result | set_pattern (pattern_string_t sPattern) noexcept |
| Set a message pattern that will be used for this stream. More... | |
| std::optional< string_view > | get_pattern () const noexcept |
| Get a message pattern if present. More... | |
| void | log (const category &category, verbosity eVerbosity, std::thread::id threadId, std::chrono::system_clock::time_point messageTime, string_view svFile, string_view svFunction, int nLine, string_view svMessage) |
| Output to stream. More... | |
| void | flush () |
| Flush the stream. | |
| virtual bool | log_unconditionally_required (const category &category, verbosity eVerbosity, std::thread::id threadId, std::chrono::system_clock::time_point messageTime, string_view svFile, string_view svFunction, int nLine) const noexcept |
| Returns true if this message should be processed by this stream even if the logger filters did not pass it. More... | |
| Public Member Functions inherited from qx::rtti_root< naming_strategy_t > | |
| template<class T > | |
| bool | is_derived_from () const noexcept |
| Test exact identity or membership in the object's RTTI base chain. More... | |
| template<class T > | |
| bool | is () const noexcept |
| Compare the object's dynamic class identifier with T's identifier. More... | |
| bool | is (string_view svClassName) const noexcept |
| Compare against the class name selected by the naming strategy. More... | |
| bool | is (const class_id &id) const noexcept |
| Compare against the object's dynamic class identifier. More... | |
| virtual bool | is_derived_from_id (const class_id &id) const noexcept |
| Test an identifier against the object's dynamic RTTI hierarchy. More... | |
| virtual string_view | get_class_name () const noexcept |
| Get the name of the object's most-derived registered RTTI type. More... | |
| virtual class_id | get_class_id () const noexcept |
| Get the identifier of the object's most-derived registered RTTI type. More... | |
| virtual std::span< const class_id > | get_inheritance_sequence () const =0 |
| Get the registered inheritance chain in base-to-derived order. More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from qx::rtti_root< naming_strategy_t > | |
| static constexpr bool | is_derived_from_id_static (const class_id &id) noexcept |
| Test an identifier against the declaring type's static RTTI hierarchy. More... | |
| static constexpr string_view | get_class_name_static () noexcept |
| Apply the naming strategy to the declaring RTTI type's signature. More... | |
| static constexpr class_id | get_class_id_static () noexcept |
| Create the declaring RTTI type's identifier from its type signature. More... | |
| Protected Member Functions inherited from qx::base_file_logger_stream | |
| std::filesystem::path | prepare_folder_and_get_log_file_path (const config &config) noexcept |
| Create a folder (if required) and get log file path. More... | |
| Protected Member Functions inherited from qx::rtti_root< naming_strategy_t > | |
| virtual bool | _is_base_id (const class_id &idBase) const noexcept |
| Traverse identifiers treated as bases by derived RTTI classes. More... | |
Detailed Description
High-performance file logger based on memory-mapped I/O.
This logger implementation writes log data directly into a memory-mapped file region (mmap / CreateFileMapping). Instead of using traditional buffered I/O (fopen / WriteFile), the file is mapped into the process address space and written via simple memory copies.
UTF-8 LE (char) or UTF-16 LE (wchar_t).
While the file is open for writing, a sequence of NUL characters appears at the end of the file. This is expected and follows the logic of how memory-mapped files work. These characters will be truncated when the object is destroyed, usually when an application is closed.
- Date
- 15.01.2026
Definition at line 47 of file file_logger_stream_mapping.h.
Constructor & Destructor Documentation
◆ file_logger_stream_mapping()
|
inlinenoexcept |
file_logger_stream_mapping object constructor
- Parameters
-
streamConfig - file logger configuration initialMapSize - initial mapping size (outer capacity). mapping grows when needed
Definition at line 13 of file file_logger_stream_mapping.inl.
Member Function Documentation
◆ do_log()
|
inlineoverridevirtual |
Proceed stream logging.
- Parameters
-
category - code category eVerbosity - this message verbosity threadId - thread where the log is called messageTime - message creation time svFile - file name string svFunction - function name string nLine - code line number svMessage - message string
Implements qx::base_logger_stream.
Definition at line 140 of file file_logger_stream_mapping.inl.
The documentation for this class was generated from the following files:
- include/qx/logger/file_logger_stream_mapping.h
- include/qx/logger/file_logger_stream_mapping.inl
