sopc_logger.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_LOGGER_H_
#define SOPC_LOGGER_H_
 
#include <stdbool.h>
#include <stdint.h>
 
#include "sopc_log_manager.h"
 
#ifdef __GNUC__
#define ATTR_FORMAT(archetype, string_index, first) __attribute__((format(archetype, string_index, first)))
#else
#define ATTR_FORMAT(archetype, string_index, first)
#endif
 
#define LOGGER_FUNC_FORMAT_ENUM ATTR_FORMAT(printf, 2, 3)
#define LOGGER_FUNC_FORMAT ATTR_FORMAT(printf, 1, 2)
 
typedef enum SOPC_Log_Module
{
    SOPC_LOG_MODULE_COMMON,       
    SOPC_LOG_MODULE_CLIENTSERVER, 
    SOPC_LOG_MODULE_PUBSUB        
} SOPC_Log_Module;
 
bool SOPC_Logger_Initialize(const SOPC_Log_Configuration* const logConfiguration);
 
SOPC_Log_Instance* SOPC_Logger_AddUserInstance(const char* category);
 
void SOPC_Logger_SetTraceLogLevel(SOPC_Log_Level level);
 
SOPC_Log_Level SOPC_Logger_GetTraceLogLevel(void);
 
void SOPC_Logger_SetConsoleOutput(bool activate);
 
void SOPC_Logger_TraceError(SOPC_Log_Module logModule, const char* format, ...) LOGGER_FUNC_FORMAT_ENUM;
 
void SOPC_Logger_TraceWarning(SOPC_Log_Module logModule, const char* format, ...) LOGGER_FUNC_FORMAT_ENUM;
 
void SOPC_Logger_TraceInfo(SOPC_Log_Module logModule, const char* format, ...) LOGGER_FUNC_FORMAT_ENUM;
 
/*
 * \brief Log a trace with the debug level
 *
 * \param logModule The log module
 * \param format    String specifying how subsequent arguments are converted for output
 */
void SOPC_Logger_TraceDebug(SOPC_Log_Module logModule, const char* format, ...) LOGGER_FUNC_FORMAT_ENUM;
 
void SOPC_Logger_TraceSecurityAudit(const char* format, ...) LOGGER_FUNC_FORMAT;
 
void SOPC_Logger_TraceSecurityAuditWarning(const char* format, ...) LOGGER_FUNC_FORMAT;
 
void SOPC_Logger_TraceOpcUaAudit(const char* format, ...) LOGGER_FUNC_FORMAT;
 
void SOPC_Logger_TraceOpcUaAuditWarning(const char* format, ...) LOGGER_FUNC_FORMAT;
 
void SOPC_Logger_Clear(void);
 
#endif /* SOPC_LOGGER_H_ */