basic_file_sink.h 2.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465
  1. // Copyright(c) 2015-present, Gabi Melman & spdlog contributors.
  2. // Distributed under the MIT License (http://opensource.org/licenses/MIT)
  3. #pragma once
  4. #include <spdlog/details/file_helper.h>
  5. #include <spdlog/details/null_mutex.h>
  6. #include <spdlog/details/synchronous_factory.h>
  7. #include <spdlog/sinks/base_sink.h>
  8. #include <mutex>
  9. #include <string>
  10. namespace spdlog {
  11. namespace sinks {
  12. /*
  13. * Trivial file sink with single file as target
  14. */
  15. template <typename Mutex>
  16. class basic_file_sink final : public base_sink<Mutex> {
  17. public:
  18. explicit basic_file_sink(const filename_t &filename,
  19. bool truncate = false,
  20. const file_event_handlers &event_handlers = {});
  21. const filename_t &filename() const;
  22. protected:
  23. void sink_it_(const details::log_msg &msg) override;
  24. void flush_() override;
  25. private:
  26. details::file_helper file_helper_;
  27. };
  28. using basic_file_sink_mt = basic_file_sink<std::mutex>;
  29. using basic_file_sink_st = basic_file_sink<details::null_mutex>;
  30. } // namespace sinks
  31. //
  32. // factory functions
  33. //
  34. template <typename Factory = spdlog::synchronous_factory>
  35. inline std::shared_ptr<logger> basic_logger_mt(const std::string &logger_name,
  36. const filename_t &filename,
  37. bool truncate = false,
  38. const file_event_handlers &event_handlers = {}) {
  39. return Factory::template create<sinks::basic_file_sink_mt>(logger_name, filename, truncate,
  40. event_handlers);
  41. }
  42. template <typename Factory = spdlog::synchronous_factory>
  43. inline std::shared_ptr<logger> basic_logger_st(const std::string &logger_name,
  44. const filename_t &filename,
  45. bool truncate = false,
  46. const file_event_handlers &event_handlers = {}) {
  47. return Factory::template create<sinks::basic_file_sink_st>(logger_name, filename, truncate,
  48. event_handlers);
  49. }
  50. } // namespace spdlog
  51. #ifdef SPDLOG_HEADER_ONLY
  52. #include "basic_file_sink-inl.h"
  53. #endif