Parse diagnostic logs emitted by the device. More...

#include <sbgCommon.h>
#include <streamBuffer/sbgStreamBuffer.h>
#include <protocol/sbgEComProtocol.h>

Data Structures
struct	_SbgEComLogDiagData

Macros
#define	SBG_ECOM_LOG_DIAG_MAX_STRING_SIZE (SBG_ECOM_MAX_PAYLOAD_SIZE - 6)

Typedefs
typedef struct _SbgEComLogDiagData	SbgEComLogDiagData

Functions
SbgErrorCode	sbgEComLogDiagReadFromStream (SbgEComLogDiagData pLogData, SbgStreamBuffer pStreamBuffer)

SbgErrorCode	sbgEComLogDiagWriteToStream (const SbgEComLogDiagData pLogData, SbgStreamBuffer pStreamBuffer)

Detailed Description

Parse diagnostic logs emitted by the device.

Author: SBG Systems

Date: 12 June 2019

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

License

The MIT license

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

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.

Typedef Documentation

◆ SbgEComLogDiagData

typedef struct _SbgEComLogDiagData SbgEComLogDiagData

Diagnostic log structure.

Function Documentation

◆ sbgEComLogDiagReadFromStream()

SbgErrorCode sbgEComLogDiagReadFromStream	(	SbgEComLogDiagData *	pLogData,
		SbgStreamBuffer *	pStreamBuffer
	)

Parse data for the SBG_ECOM_LOG_DIAG message and fill the corresponding structure.

Parameters

[out]	pLogData	Log structure instance to fill.
[in]	pStreamBuffer	Input stream buffer to read the log from.

Returns: SBG_NO_ERROR if a valid log has been read from the stream buffer.

◆ sbgEComLogDiagWriteToStream()

SbgErrorCode sbgEComLogDiagWriteToStream	(	const SbgEComLogDiagData *	pLogData,
		SbgStreamBuffer *	pStreamBuffer
	)

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

Parameters

[in]	pLogData	Log structure instance to write.
[out]	pStreamBuffer	Output stream buffer to write the log to.

Returns: SBG_NO_ERROR if the log has been written to the stream buffer.

Data Structures

Macros

Typedefs

Functions