sopc_common.h File Reference

#include "sopc_enums.h"
#include <inttypes.h>
#include "sopc_log_manager.h"

Go to the source code of this file.

Functions
bool	SOPC_Common_IsInitialized (void)
	return Common module initialization status More...
SOPC_ReturnStatus	SOPC_Common_Initialize (SOPC_Log_Configuration logConfiguration)
	Initializes Common module. More...
void	SOPC_Common_Clear (void)
	clear common library (including logs) More...
SOPC_ReturnStatus	SOPC_Common_SetLogLevel (SOPC_Log_Level level)
	set general log level More...
SOPC_Log_Configuration	SOPC_Common_GetDefaultLogConfiguration (void)
	retrieve the default log configuration More...

Function Documentation

SOPC_Common_IsInitialized()

bool SOPC_Common_IsInitialized

(

void

)

return Common module initialization status

Returns

initialization status

SOPC_Common_Initialize()

SOPC_ReturnStatus SOPC_Common_Initialize

(

SOPC_Log_Configuration

logConfiguration

)

Initializes Common module.

Parameters

[in]

logConfiguration

log configuration

Returns

SOPC_STATUS_OK if initialization is a success SOPC_STATUS_INVALID_PARAMETERS if logConfiguration is invalid SOPC_STATUS_INVALID_STATE if initialization has already been done. SOPC_STATUS_NOK else

SOPC_Common_Clear()

void SOPC_Common_Clear

(

void

)

clear common library (including logs)

SOPC_Common_SetLogLevel()

SOPC_ReturnStatus SOPC_Common_SetLogLevel

(

SOPC_Log_Level

level

)

set general log level

Parameters

[in]

level

target log level

Returns

SOPC_STATUS_OK

SOPC_Common_GetDefaultLogConfiguration()

SOPC_Log_Configuration SOPC_Common_GetDefaultLogConfiguration

(

void

)

retrieve the default log configuration

The configuration can be used directly, or modified as the user desires.

Returns

the default log configuration