99 lines
2.7 KiB
C++
99 lines
2.7 KiB
C++
/***
|
|
Copyright (C) 2021 J Reece Wilson (a/k/a "Reece"). All rights reserved.
|
|
|
|
File: Sinks.hpp
|
|
Date: 2021-11-2
|
|
Author: Reece
|
|
***/
|
|
#pragma once
|
|
|
|
namespace Aurora
|
|
{
|
|
struct SocketConsole;
|
|
}
|
|
|
|
namespace Aurora::IO
|
|
{
|
|
struct IStreamWriter;
|
|
}
|
|
|
|
namespace Aurora::Logging
|
|
{
|
|
struct DirectoryLogger
|
|
{
|
|
AuUInt32 uMaxLogsOrZeroBeforeCompress {};
|
|
AuUInt32 uMaxLogsOrZeroBeforeDelete {};
|
|
AuUInt32 uMaxCumulativeFileSizeInMiBOrZeroBeforeCompress {};
|
|
AuUInt32 uMaxCumulativeFileSizeInMiBOrZeroBeforeDelete {};
|
|
AuUInt32 uMaxFileTimeInDeltaMSOrZeroBeforeCompress {};
|
|
AuUInt32 uMaxFileTimeInDeltaMSOrZeroBeforeDelete {};
|
|
};
|
|
|
|
AUE_DEFINE(ELogMode,
|
|
(
|
|
eText,
|
|
eBinary
|
|
));
|
|
|
|
AUE_DEFINE(EPrefixMode,
|
|
(
|
|
eNoPrefix,
|
|
eIncludeU32BlockLength
|
|
));
|
|
|
|
struct StreamLogger
|
|
{
|
|
EPrefixMode ePrefixMode { EPrefixMode::eNoPrefix };
|
|
ELogMode eLogMode { ELogMode::eText };
|
|
AuSPtr<Aurora::IO::IStreamWriter> pOutputStream;
|
|
};
|
|
|
|
/**
|
|
* @brief Constructs a UTF8 output sink.
|
|
* Backed by stdconsole; supports posix fd stdin/out localized, visual studio debugger, and conhost
|
|
*/
|
|
AUKN_SHARED_API(NewStdSink, IFormattedSink);
|
|
|
|
/**
|
|
* @brief Unimplemented systemd or service (?) backend
|
|
*/
|
|
AUKN_SHARED_API(NewOSEventDirectorySink, IBasicSink);
|
|
|
|
/**
|
|
* @brief Constructs a new sink backed by syslog or eventlog, by name or event source respectively
|
|
*/
|
|
AUKN_SHARED_API(NewOSNamedEventDirectorySink, IBasicSink, const AuString &name);
|
|
|
|
/**
|
|
* @brief Visual Studio Output
|
|
*/
|
|
AUKN_SHARED_API(NewDebugLogger, IBasicSink);
|
|
|
|
/*s*
|
|
* @brief Constructs a sink of a human-readable text or binary log file
|
|
*/
|
|
AUKN_SHARED_API(NewFileSink, IFormattedSink, const AuString &path, ELogMode eMode = ELogMode::eText);
|
|
|
|
/**
|
|
* @brief Constructs a dedicated log directory subject to erasure as defined by defined DirectoryLogger
|
|
*/
|
|
AUKN_SHARED_API(NewDirectorySink, IBasicSink, const AuString &path, DirectoryLogger dirInfo, ELogMode eMode = ELogMode::eText);
|
|
|
|
/**
|
|
* @brief
|
|
*/
|
|
AUKN_SHARED_API(NewIPCSink, IIPCLogger, const AuString &path, EPrefixMode ePrefixMode = EPrefixMode::eNoPrefix);
|
|
|
|
/**
|
|
* @brief Constructs an in-memory ring buffer sink
|
|
*/
|
|
AUKN_SHARED_API(NewRingLogger, IBasicSinkRB, AuUInt32 maxLogEntries);
|
|
|
|
|
|
AUKN_SHARED_API(NewStreamSink, IFormattedSink, const StreamLogger &streamLogger);
|
|
|
|
/**
|
|
* @brief Constructs a logger object from an array of sinks
|
|
*/
|
|
AUKN_SHARED_API(NewLogger, ILogger, const AuList<AuSPtr<IBasicSink>> &sinks);
|
|
} |