Classes | Macros | Typedefs | Functions
sbgEComBinaryLogDiag.h File Reference

Diagnostic log handling. More...

#include <sbgCommon.h>
#include <streamBuffer/sbgStreamBuffer.h>
#include "../protocol/sbgEComProtocol.h"
Include dependency graph for sbgEComBinaryLogDiag.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  _SbgLogDiagData
 

Macros

#define SBG_ECOM_LOG_DIAG_MAX_STRING_SIZE   (SBG_ECOM_MAX_PAYLOAD_SIZE - 6)
 

Typedefs

typedef struct _SbgLogDiagData SbgLogDiagData
 

Functions

SbgErrorCode sbgEComBinaryLogParseDiagData (SbgStreamBuffer *pInputStream, SbgLogDiagData *pOutputData)
 
SbgErrorCode sbgEComBinaryLogWriteDiagData (SbgStreamBuffer *pOutputStream, const SbgLogDiagData *pInputData)
 

Detailed Description

Diagnostic log handling.

Author
SBG Systems
Date
12 June 2019

Copyright Notice

Copyright (C) 2019, SBG Systems SAS. All rights reserved.

This source code is intended for use only by SBG Systems SAS and those that have explicit written permission to use it from SBG Systems SAS.

THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.

Definition in file sbgEComBinaryLogDiag.h.

Macro Definition Documentation

◆ SBG_ECOM_LOG_DIAG_MAX_STRING_SIZE

#define SBG_ECOM_LOG_DIAG_MAX_STRING_SIZE   (SBG_ECOM_MAX_PAYLOAD_SIZE - 6)

Maximum size of the log string, in bytes.

Definition at line 37 of file sbgEComBinaryLogDiag.h.

Typedef Documentation

◆ SbgLogDiagData

Diagnostic log structure.

Function Documentation

◆ sbgEComBinaryLogParseDiagData()

SbgErrorCode sbgEComBinaryLogParseDiagData ( SbgStreamBuffer pInputStream,
SbgLogDiagData pOutputData 
)

Parse data for SBG_ECOM_LOG_DIAG messages and fill the corresponding structure.

Parameters
[in]pInputStreamInput stream buffer to read the payload from.
[out]pOutputDataPointer on the output structure that stores parsed data.
Returns
SBG_NO_ERROR if the payload has been parsed.

Definition at line 12 of file sbgEComBinaryLogDiag.c.

◆ sbgEComBinaryLogWriteDiagData()

SbgErrorCode sbgEComBinaryLogWriteDiagData ( SbgStreamBuffer pOutputStream,
const SbgLogDiagData pInputData 
)

Write data for SBG_ECOM_LOG_DIAG messages to the output stream buffer from the provided structure.

Parameters
[out]pOutputStreamOutput stream buffer to write the payload to.
[in]pInputDataPointer on the input structure that stores data to write.
Returns
SBG_NO_ERROR if the message has been generated in the provided buffer.

Definition at line 27 of file sbgEComBinaryLogDiag.c.



sbg_driver
Author(s): SBG Systems
autogenerated on Sat Sep 3 2022 02:53:36