From 9f34c58b3e2f27840b758b0223dfe7d096f9dcb2 Mon Sep 17 00:00:00 2001 From: gabime Date: Thu, 15 Jan 2015 11:01:54 +0200 Subject: [PATCH] comments --- include/spdlog/common.h | 2 +- include/spdlog/spdlog.h | 8 +++++++- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/include/spdlog/common.h b/include/spdlog/common.h index 3408bcb9..e9202b19 100644 --- a/include/spdlog/common.h +++ b/include/spdlog/common.h @@ -77,7 +77,7 @@ inline const char* to_str(spdlog::level::level_enum l) // -// Async mode - off by default. +// Async overflow policy - block by default. // enum class async_overflow_policy { diff --git a/include/spdlog/spdlog.h b/include/spdlog/spdlog.h index 57223eec..e2104b74 100644 --- a/include/spdlog/spdlog.h +++ b/include/spdlog/spdlog.h @@ -57,8 +57,14 @@ void set_formatter(formatter_ptr f); void set_level(level::level_enum log_level); -// Turn on async mode and set the queue size for each async_logger +// Turn on async mode and set the queue size for each async_logger. +// queue_size: size of queue (must be power of 2). The queue will pre allocate queue_size entries upon construction. +// async_overflow_policy (optional): +// async_overflow_policy::block_retry (default policy, if queue is full, block until queue has room for the new log entry) +// async_overflow_policy::discard_log_msg (never block and discard any new messages when queue overflows) +// worker_warmup_cb(optional): callback function that will be called in worker thread upon start (can be used to init stuff like thread affinity) void set_async_mode(size_t queue_size, const async_overflow_policy overflow_policy = async_overflow_policy::block_retry, const std::function& worker_warmup_cb = nullptr); + // Turn off async mode void set_sync_mode();