LogV.h

/* See Project CHIP LICENSE file for licensing information. */

#pragma once

#include <lib/support/EnforceFormat.h>
#include <stdarg.h>
#include <stdint.h>

namespace chip {
namespace Logging {
namespace Platform {

/**
 * Log, to the platform-specified mechanism, the specified log
 * message, @a msg, for the specified module, @a module, in the
 * provided category, @a category.
 *
 * @param[in] module    The name of the log module.
 * @param[in] category  A LogCategory enumeration indicating the
 *                      category of the log message. The category
 *                      may be filtered in or out if
 *                      CHIP_LOG_FILTERING was asserted.
 * @param[in] msg       A pointer to a NULL-terminated C string with
 *                      C Standard Library-style format specifiers
 *                      containing the log message to be formatted and
 *                      logged.
 * @param[in] v         A variadic argument list whose elements should
 *                      correspond to the format specifiers in @a msg.
 *
 */
void ENFORCE_FORMAT(3, 0) LogV(const char * module, uint8_t category, const char * msg, va_list v);

/**
 * Open a log file for appending log messages. This function opens
 * the specified file and ensures that subsequent logs are written to
 * this file. It should be called at the start of the application
 * before any logging is done.
 *
 * @param[in] filePath  The path to the log file. If the file does not
 *                      exist, it will be created. If it exists, log
 *                      messages will be appended to it.
 */
void OpenLogFile(const char * filePath);

/**
 * Close the log file if it is open. This function should be called
 * at the end of the application to ensure that all log messages are
 * flushed to disk and the file is properly closed.
 */
void CloseLogFile();

} // namespace Platform
} // namespace Logging
} // namespace chip