sbgEComLogDiag.h

Go to the documentation of this file.

 
#ifndef SBG_ECOM_LOG_DIAG_H
#define SBG_ECOM_LOG_DIAG_H
 
// sbgCommonLib headers
#include <sbgCommon.h>
#include <streamBuffer/sbgStreamBuffer.h>
 
// Project headers
#include <protocol/sbgEComProtocol.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
//----------------------------------------------------------------------//
//- Constant definitions                                               -//
//----------------------------------------------------------------------//

#define SBG_ECOM_LOG_DIAG_MAX_STRING_SIZE                   (SBG_ECOM_MAX_PAYLOAD_SIZE - 6)
 
//----------------------------------------------------------------------//
//- Structure definitions                                              -//
//----------------------------------------------------------------------//

typedef struct _SbgEComLogDiagData
{
    uint32_t                             timestamp;                                    
    SbgDebugLogType                       type;                                      
    SbgErrorCode                         errorCode;                                    
    char                                 string[SBG_ECOM_LOG_DIAG_MAX_STRING_SIZE];    
} SbgEComLogDiagData;
 
//----------------------------------------------------------------------//
//- Public methods                                                     -//
//----------------------------------------------------------------------//

SbgErrorCode sbgEComLogDiagReadFromStream(SbgEComLogDiagData *pLogData, SbgStreamBuffer *pStreamBuffer);

SbgErrorCode sbgEComLogDiagWriteToStream(const SbgEComLogDiagData *pLogData, SbgStreamBuffer *pStreamBuffer);
 
//----------------------------------------------------------------------//
//- DEPRECATED - Used for backward compatibility                       -//
//----------------------------------------------------------------------//
 
SBG_DEPRECATED_TYPEDEF(typedef struct _SbgEComLogDiagData SbgLogDiagData);
 
SBG_DEPRECATED(SbgErrorCode sbgEComBinaryLogParseDiagData(SbgStreamBuffer *pStreamBuffer, SbgEComLogDiagData *pLogData));
SBG_DEPRECATED(SbgErrorCode sbgEComBinaryLogWriteDiagData(SbgStreamBuffer *pStreamBuffer, const SbgEComLogDiagData *pLogData));
 
#ifdef __cplusplus
}
#endif
 
#endif // SBG_ECOM_LOG_DIAG_H