mirror of https://github.com/PentHertz/srsLTE.git
52 lines
1.3 KiB
C++
52 lines
1.3 KiB
C++
/**
|
|
*
|
|
* \section COPYRIGHT
|
|
*
|
|
* Copyright 2013-2021 Software Radio Systems Limited
|
|
*
|
|
* By using this file, you agree to the terms and conditions set
|
|
* forth in the LICENSE file which can be found at the top level of
|
|
* the distribution.
|
|
*
|
|
*/
|
|
|
|
#ifndef SRSLOG_SINK_H
|
|
#define SRSLOG_SINK_H
|
|
|
|
#include "srsran/srslog/detail/support/error_string.h"
|
|
#include "srsran/srslog/detail/support/memory_buffer.h"
|
|
#include "srsran/srslog/formatter.h"
|
|
#include <cassert>
|
|
|
|
namespace srslog {
|
|
|
|
/// This interface provides the way to write incoming memory buffers to any kind
|
|
/// of backing store.
|
|
class sink
|
|
{
|
|
public:
|
|
explicit sink(std::unique_ptr<log_formatter> f) : formatter(std::move(f))
|
|
{
|
|
assert(formatter && "Invalid formatter");
|
|
}
|
|
|
|
virtual ~sink() = default;
|
|
|
|
/// Returns the formatter used by this sink.
|
|
log_formatter& get_formatter() { return *formatter; }
|
|
const log_formatter& get_formatter() const { return *formatter; }
|
|
|
|
/// Writes the provided memory buffer into the sink.
|
|
virtual detail::error_string write(detail::memory_buffer buffer) = 0;
|
|
|
|
/// Flushes any buffered contents to the backing store.
|
|
virtual detail::error_string flush() = 0;
|
|
|
|
private:
|
|
std::unique_ptr<log_formatter> formatter;
|
|
};
|
|
|
|
} // namespace srslog
|
|
|
|
#endif // SRSLOG_SINK_H
|