feat: Make logging period adjustable with defualt of 200 ms

Author: cwahn

example/efp_logger_example.cpp

@@ -8,6 +8,9 @@ int main() {
     // Optional log level setting. Default is LogLevel::Info
     Logger::set_log_level(LogLevel::Trace);
 
+    // Optional log period setting. Default is 200ms
+    // Logger::set_log_period(std::chrono::milliseconds(1000));
+
     // Optional log output setting. // default is stdout
     // Logger::set_output("./efp_logger_test.log");
     // Logger::set_output(stdout);
@@ -21,10 +24,15 @@ int main() {
 
     // Use the logging functions
     trace("This is a trace message with no formating");
-    debug("This is a debug message with a pointer: {:p}", (void*)&x);
+    std::this_thread::sleep_for(std::chrono::milliseconds(500));
+    debug("This is a debug message with a pointer: {}", (void*)&x);
+    std::this_thread::sleep_for(std::chrono::milliseconds(500));
     info("This is a info message with a float: {}", 3.14f);
+    std::this_thread::sleep_for(std::chrono::milliseconds(500));
     warn("This is a warn message with a int: {}", 42);
+    std::this_thread::sleep_for(std::chrono::milliseconds(500));
     error("This is a error message with a string literal: {}", "error");
+    std::this_thread::sleep_for(std::chrono::milliseconds(500));
     // ! Sending std::string to the buffer is O(n) and may increase risk of buffer overflow
     // ! Every 20 ~ 30 char will take one buffer space.
     fatal("This is a fatal message with a std::string: {}", std::string("fatal error"));

include/efp/logger.hpp

@@ -86,8 +86,8 @@ namespace efp {
             LogLevel level;
         };
 
-        constexpr uint8_t stl_string_data_capacity = sizeof(FormatedMessage);
-        constexpr uint8_t stl_string_head_capacity = stl_string_data_capacity - sizeof(size_t);
+        constexpr size_t stl_string_data_capacity = sizeof(FormatedMessage);
+        constexpr size_t stl_string_head_capacity = stl_string_data_capacity - sizeof(size_t);
 
         // Data structure for std::string preventing each char takes size of full Enum;
         struct StlStringHead {
@@ -380,15 +380,21 @@ namespace efp {
         }
 
         static inline void set_log_level(LogLevel log_level) {
-
             instance()._log_buffer.set_log_level(log_level);
         }
 
         static inline LogLevel get_log_level() {
             return instance()._log_buffer.get_log_level();
         }
 
-        static void set_output(FILE* output_file) {
+        static inline void set_log_period(std::chrono::milliseconds period) {
+            _period = period;
+        }
+
+        static inline std::chrono::milliseconds get_log_period() { return _period; }
+
+        static void
+        set_output(FILE* output_file) {
             instance()._log_buffer.set_output_file(output_file);
         }
 
@@ -449,25 +455,35 @@ namespace efp {
               _run(true),
               _thread([&]() {
                   while (_run.load()) {
+                      const auto start_time_point = std::chrono::steady_clock::now();
 #if EFP_LOG_TIME_STAMP == true
                       process_with_time();
 #else
                       process();
 #endif
-                      // todo periodic
-                      std::this_thread::sleep_for(std::chrono::milliseconds{1});
+                      const auto end_time_point = std::chrono::steady_clock::now();
+                      const auto elapsed_time =
+                          std::chrono::duration_cast<std::chrono::milliseconds>(
+                              end_time_point - start_time_point);
+
+                      if (elapsed_time < _period) {
+                          std::this_thread::sleep_for(_period - elapsed_time);
+                      }
                   }
               }) {
         }
 
+        static std::chrono::milliseconds _period;
+
         LogLevel _log_level;
 
         detail::LogBuffer _log_buffer;
-
         std::atomic<bool> _run;
         std::thread _thread;
     };
 
+    std::chrono::milliseconds Logger::_period = std::chrono::milliseconds(200);
+
     // LogLevel Logger::instance().log_level = LogLevel::Debug;
 
     namespace detail {