1// Copyright(c) 2015-present, Gabi Melman & spdlog contributors.
2// Distributed under the MIT License (http://opensource.org/licenses/MIT)
3
4#pragma once
5
6#include "spdlog/details/circular_q.h"
7#include "spdlog/details/log_msg_buffer.h"
8#include "spdlog/details/null_mutex.h"
9#include "spdlog/sinks/base_sink.h"
10
11#include <mutex>
12#include <string>
13#include <vector>
14
15namespace spdlog {
16namespace sinks {
17/*
18 * Ring buffer sink
19 */
20template <typename Mutex>
21class ringbuffer_sink final : public base_sink<Mutex> {
22public:
23 explicit ringbuffer_sink(size_t n_items)
24 : q_{n_items} {}
25
26 std::vector<details::log_msg_buffer> last_raw(size_t lim = 0) {
27 std::lock_guard<Mutex> lock(base_sink<Mutex>::mutex_);
28 auto items_available = q_.size();
29 auto n_items = lim > 0 ? (std::min)(a: lim, b: items_available) : items_available;
30 std::vector<details::log_msg_buffer> ret;
31 ret.reserve(n: n_items);
32 for (size_t i = (items_available - n_items); i < items_available; i++) {
33 ret.push_back(x: q_.at(i));
34 }
35 return ret;
36 }
37
38 std::vector<std::string> last_formatted(size_t lim = 0) {
39 std::lock_guard<Mutex> lock(base_sink<Mutex>::mutex_);
40 auto items_available = q_.size();
41 auto n_items = lim > 0 ? (std::min)(a: lim, b: items_available) : items_available;
42 std::vector<std::string> ret;
43 ret.reserve(n: n_items);
44 for (size_t i = (items_available - n_items); i < items_available; i++) {
45 memory_buf_t formatted;
46 base_sink<Mutex>::formatter_->format(q_.at(i), formatted);
47 ret.push_back(SPDLOG_BUF_TO_STRING(formatted));
48 }
49 return ret;
50 }
51
52protected:
53 void sink_it_(const details::log_msg &msg) override {
54 q_.push_back(item: details::log_msg_buffer{msg});
55 }
56 void flush_() override {}
57
58private:
59 details::circular_q<details::log_msg_buffer> q_;
60};
61
62using ringbuffer_sink_mt = ringbuffer_sink<std::mutex>;
63using ringbuffer_sink_st = ringbuffer_sink<details::null_mutex>;
64
65} // namespace sinks
66
67} // namespace spdlog
68