sbgEComBinaryLogEvent.h File Reference

This file is used to parse received event markers binary logs. More...

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

Include dependency graph for sbgEComBinaryLogEvent.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	_SbgLogEvent

Macros
#define	SBG_ECOM_EVENT_OFFSET_0_VALID   (0x00000001u << 1)
#define	SBG_ECOM_EVENT_OFFSET_1_VALID   (0x00000001u << 2)
#define	SBG_ECOM_EVENT_OFFSET_2_VALID   (0x00000001u << 3)
#define	SBG_ECOM_EVENT_OFFSET_3_VALID   (0x00000001u << 4)
#define	SBG_ECOM_EVENT_OVERFLOW   (0x00000001u << 0)

Typedefs
typedef struct _SbgLogEvent	SbgLogEvent

Functions
SbgErrorCode	sbgEComBinaryLogParseEvent (SbgStreamBuffer *pInputStream, SbgLogEvent *pOutputData)
SbgErrorCode	sbgEComBinaryLogWriteEvent (SbgStreamBuffer *pOutputStream, const SbgLogEvent *pInputData)

Detailed Description

This file is used to parse received event markers binary logs.

Author

SBG Systems (Raphael Siryani)

Date

28 October 2013

Copyright Notice

Copyright (C) 2007-2013, 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 sbgEComBinaryLogEvent.h.

Macro Definition Documentation

#define SBG_ECOM_EVENT_OFFSET_0_VALID   (0x00000001u << 1)

Set to 1 if at least two events have been received.

Definition at line 34 of file sbgEComBinaryLogEvent.h.

#define SBG_ECOM_EVENT_OFFSET_1_VALID   (0x00000001u << 2)

Set to 1 if at least three events have been received.

Definition at line 35 of file sbgEComBinaryLogEvent.h.

#define SBG_ECOM_EVENT_OFFSET_2_VALID   (0x00000001u << 3)

Set to 1 if at least four events have been received.

Definition at line 36 of file sbgEComBinaryLogEvent.h.

#define SBG_ECOM_EVENT_OFFSET_3_VALID   (0x00000001u << 4)

Set to 1 if at least five events have been received.

Definition at line 37 of file sbgEComBinaryLogEvent.h.

#define SBG_ECOM_EVENT_OVERFLOW   (0x00000001u << 0)

Log market events status mask definitionsSet to 1 if we have received events at a higher rate than 1 kHz.

Definition at line 33 of file sbgEComBinaryLogEvent.h.

Typedef Documentation

typedef struct _SbgLogEvent SbgLogEvent

Structure that stores data for the SBG_ECOM_LOG_EVENT_# message.

Function Documentation

SbgErrorCode sbgEComBinaryLogParseEvent	(	SbgStreamBuffer *	pInputStream,
		SbgLogEvent *	pOutputData
	)

Parse data for the SBG_ECOM_LOG_EVENT_# message and fill the corresponding structure.

Parameters

[in]	pInputStream	Input stream buffer to read the payload from.
[out]	pOutputData	Pointer on the output structure that stores parsed data.

Returns

SBG_NO_ERROR if the payload has been parsed.

Definition at line 13 of file sbgEComBinaryLogEvent.c.

SbgErrorCode sbgEComBinaryLogWriteEvent	(	SbgStreamBuffer *	pOutputStream,
		const SbgLogEvent *	pInputData
	)

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

Parameters

[out]	pOutputStream	Output stream buffer to write the payload to.
[in]	pInputData	Pointer 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 43 of file sbgEComBinaryLogEvent.c.