sopc_log_manager.h

Go to the documentation of this file.

/*
 * Licensed to Systerel under one or more contributor license
 * agreements. See the NOTICE file distributed with this work
 * for additional information regarding copyright ownership.
 * Systerel licenses this file to you under the Apache
 * License, Version 2.0 (the "License"); you may not use this
 * file except in compliance with the License. You may obtain
 * a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
 
#ifndef SOPC_LOG_MANAGER_H_
#define SOPC_LOG_MANAGER_H_
 
#include <stdarg.h>
#include <stdbool.h>
#include <stdint.h>
 
#include "sopc_circular_log_file.h"
 
typedef struct SOPC_Log_Instance SOPC_Log_Instance;
 
typedef enum
{
    SOPC_LOG_LEVEL_ERROR = 0,
    SOPC_LOG_LEVEL_WARNING = 1,
    SOPC_LOG_LEVEL_INFO = 2,
    SOPC_LOG_LEVEL_DEBUG = 3
} SOPC_Log_Level;
 
typedef void SOPC_Log_UserDoLog(const char* timestampUtc,
                                const char* category,
                                const SOPC_Log_Level level,
                                const char* const line);
 
typedef struct SOPC_LogSystem_File_Configuration
{
    const char* logDirPath; 
    uint32_t logMaxBytes;   
    uint16_t logMaxFiles;   
} SOPC_LogSystem_File_Configuration;
 
typedef struct SOPC_LogSystem_User_Configuration
{
    SOPC_Log_UserDoLog* doLog; 
} SOPC_LogSystem_User_Configuration;
 
typedef enum SOPC_Log_System
{
    SOPC_LOG_SYSTEM_FILE,  
    SOPC_LOG_SYSTEM_USER,  
    SOPC_LOG_SYSTEM_NO_LOG 
} SOPC_Log_System;
 
typedef union SOPC_Log_SystemConfiguration
{
    SOPC_LogSystem_File_Configuration fileSystemLogConfig; 
    SOPC_LogSystem_User_Configuration userSystemLogConfig; 
} SOPC_Log_SystemConfiguration;
 
typedef struct SOPC_Log_Configuration
{
    SOPC_Log_Level logLevel;   
    SOPC_Log_System logSystem; 
    SOPC_Log_SystemConfiguration logSysConfig; 
} SOPC_Log_Configuration;
 
SOPC_Log_Instance* SOPC_Log_CreateFileInstance(const SOPC_CircularLogFile_Configuration* pConf, const char* category);
 
SOPC_Log_Instance* SOPC_Log_CreateUserInstance(const char* category, SOPC_Log_UserDoLog* logCallback);
 
SOPC_Log_Instance* SOPC_Log_CreateInstanceAssociation(SOPC_Log_Instance* pLogInst, const char* category);
 
/*
 * \brief Defines the active log level for the given log instance (default: ERROR):
 * - ERROR: display only ERROR level
 * - WARNING: display ERROR + WARNING levels
 * - INFO: display ERROR + WARNING + INFO levels
 * - DEBUG: display ERROR + WARNING + INFO + DEBUG levels
 *
 * \param pLogInst  An existing log instance
 * \param level     The level to be activated for the log instance
 */
bool SOPC_Log_SetLogLevel(SOPC_Log_Instance* pLogInst, SOPC_Log_Level level);
 
SOPC_Log_Level SOPC_Log_GetLogLevel(SOPC_Log_Instance* pLogInst);
 
bool SOPC_Log_SetConsoleOutput(SOPC_Log_Instance* pLogInst, bool activate);
 
char* SOPC_Log_GetCurrentFilename(const SOPC_Log_Instance* pLogInst);
 
void SOPC_Log_Trace(SOPC_Log_Instance* pLogInst, SOPC_Log_Level level, const char* format, ...);
 
void SOPC_Log_VTrace(SOPC_Log_Instance* pLogInst, SOPC_Log_Level level, const char* format, va_list args);
 
void SOPC_Log_ClearInstance(SOPC_Log_Instance** ppLogInst);
 
#endif /* SOPC_LOG_MANAGER_H_ */