cdi_log_api.h

Go to the documentation of this file.

// -------------------------------------------------------------------------------------------
// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved.
// This file is part of the AWS CDI-SDK, licensed under the BSD 2-Clause "Simplified" License.
// License details at: https://github.com/aws/aws-cdi-sdk/blob/mainline/LICENSE
// -------------------------------------------------------------------------------------------
 
#ifndef CDI_LOG_API_H__
#define CDI_LOG_API_H__
 
#include "cdi_core_api.h"
#include "cdi_log_enums.h"
 
#include <stdbool.h>
 
//*********************************************************************************************************************
//***************************************** START OF DEFINITIONS AND TYPES ********************************************
//*********************************************************************************************************************
 
typedef void* CdiUserCbParameter;
typedef struct CdiLogMessageCbData CdiLogMessageCbData;
typedef void (*CdiLogMessageCallback)(const CdiLogMessageCbData* cb_data_ptr);
typedef struct CdiConnectionState* CdiConnectionHandle;
typedef struct CdiLogState* CdiLogHandle;
 
typedef struct CdiLogCallbackData CdiLogCallbackData;
struct CdiLogCallbackData {
    CdiLogMessageCallback log_msg_cb_ptr;
    CdiUserCbParameter log_user_cb_param;
};
 
typedef struct CdiLogMethodData CdiLogMethodData;
struct CdiLogMethodData {
    CdiLogMethod log_method;
    union {
 
        CdiLogCallbackData callback_data;
        const char* log_filename_str;
    };
};
 
typedef struct CdiLogMessageCbData CdiLogMessageCbData;
struct CdiLogMessageCbData {
    CdiConnectionHandle connection_handle;
 
    CdiUserCbParameter log_user_cb_param;
 
    CdiLogComponent component;
 
    CdiLogLevel log_level;
 
    const char* source_code_function_name_ptr;
    int source_code_line_number;
 
    int line_count;
 
    const char* message_str;
};
 
typedef void (*CdiLogMessageCallback)(const CdiLogMessageCbData* cb_data_ptr);
 
//*********************************************************************************************************************
//******************************************* START OF PUBLIC FUNCTIONS ***********************************************
//*********************************************************************************************************************
 
CDI_INTERFACE CdiReturnStatus CdiLogComponentEnable(CdiConnectionHandle handle, CdiLogComponent component, bool enable);
 
CDI_INTERFACE CdiReturnStatus CdiLogComponentEnableGlobal(CdiLogComponent component, bool enable);
 
CDI_INTERFACE bool CdiLogComponentIsEnabled(CdiConnectionHandle handle, CdiLogComponent component);
 
CDI_INTERFACE CdiReturnStatus CdiLogLevelSet(CdiConnectionHandle handle, CdiLogComponent component, CdiLogLevel level);
 
CDI_INTERFACE CdiReturnStatus CdiLogLevelSetGlobal(CdiLogComponent component, CdiLogLevel level);
 
CDI_INTERFACE CdiReturnStatus CdiLogStderrEnable(bool enable, CdiLogLevel level);
 
CDI_INTERFACE CdiLogHandle CdiLogGlobalGet(void);
 
#endif // CDI_LOG_API_H__