logger.h

Go to the documentation of this file.

/* 2025 Quantum Resistant Cryptographic Solutions Corporation
 * All Rights Reserved.
 *
 * NOTICE: This software and all accompanying materials are the exclusive 
 * property of Quantum Resistant Cryptographic Solutions Corporation (QRCS).
 * The intellectual and technical concepts contained within this implementation 
 * are proprietary to QRCS and its authorized licensors and are protected under 
 * applicable U.S. and international copyright, patent, and trade secret laws.
 *
 * CRYPTOGRAPHIC STANDAARS:
 * - This software includes implementations of cryptographic algorithms such as 
 *   SHA3, AES, and others. These algorithms are public domain or standardized 
 *   by organizations such as NIST and are NOT the property of QRCS.
 * - However, all source code, optimizations, and implementations in this library 
 *   are original works of QRCS and are protected under this license.
 *
 * RESTRICTIONS:
 * - Redistribution, modification, or unauthorized distribution of this software, 
 *   in whole or in part, is strictly prohibited.
 * - This software is provided for non-commercial, educational, and research 
 *   purposes only. Commercial use in any form is expressly forbidden.
 * - Licensing and authorized distribution are solely at the discretion of QRCS.
 * - Any use of this software implies acceptance of these restrictions.
 *
 * DISCLAIMER:
 * This software is provided "as is," without warranty of any kind, express or 
 * implied, including but not limited to warranties of merchantability or fitness 
 * for a particular purpose. QRCS disclaims all liability for any direct, indirect, 
 * incidental, or consequential damages resulting from the use or misuse of this software.
 *
 * FULL LICENSE:
 * This software is subject to the **Quantum Resistant Cryptographic Solutions 
 * Proprietary License (QRCS-PL)**. The complete license terms are included 
 * in the LICENSE.txt file distributed with this software.
 *
 * Written by: John G. Underhill
 * Contact: contact@qrcscorp.ca
 */
 
#ifndef UDIF_LOG_H
#define UDIF_LOG_H
 
#include "udifcommon.h"
#include "commands.h"


#define UDIF_LOGGING_MESSAGE_MAX 256U

#define UDIF_LOG_STRING_DEPTH 69U

#define UDIF_LOG_STRING_SIZE 64U

static const char UDIF_LOGGER_PATH[] = "UDIF";

static const char UDIF_LOGGER_FILE[] = "udif.log";

static const char UDIF_LOGGER_HEAD[] = "UDIF Version 1.0";

UDIF_EXPORT_API void logger_default_path(char* path, size_t pathlen);

UDIF_EXPORT_API bool udif_logger_dispose(const char* path);

UDIF_EXPORT_API bool udif_logger_erase_all(const char* path);

UDIF_EXPORT_API bool udif_logger_exists(const char* path);

UDIF_EXPORT_API void udif_logger_initialize(const char* path);

UDIF_EXPORT_API size_t udif_logger_get_size(const char* path);

UDIF_EXPORT_API void udif_logger_reset(const char* path);

UDIF_EXPORT_API size_t udif_logger_write_message(const char* path, const char* line, size_t linelen);

UDIF_EXPORT_API size_t udif_logger_write_decorated_message(const char* path, udif_application_messages msgtype, const char* message, size_t msglen);

UDIF_EXPORT_API size_t udif_logger_write_time_stamped_message(const char* path, const char* message, size_t msglen);

UDIF_EXPORT_API size_t udif_logger_write_decorated_time_stamped_message(const char* path, udif_application_messages msgtype, const char* message, size_t msglen);

UDIF_EXPORT_API size_t udif_logger_read_all(const char* path, char* output, size_t outlen);

UDIF_EXPORT_API int64_t udif_logger_read_line(const char* path, char* output, size_t outlen, size_t linenum);

UDIF_EXPORT_API size_t udif_logger_time_stamp(char* output, size_t outlen);
 
#endif