Specific method of stream buffer for little endian readings/writings. More...

#include "sbgStreamBufferCommon.h"

Include dependency graph for sbgStreamBufferLE.h:

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

Functions
SBG_INLINE double	sbgStreamBufferReadDoubleLE (SbgStreamBuffer *pHandle)

SBG_INLINE float	sbgStreamBufferReadFloatLE (SbgStreamBuffer *pHandle)

SBG_INLINE int16_t	sbgStreamBufferReadInt16LE (SbgStreamBuffer *pHandle)

SBG_INLINE int32_t	sbgStreamBufferReadInt24LE (SbgStreamBuffer *pHandle)

SBG_INLINE int32_t	sbgStreamBufferReadInt32LE (SbgStreamBuffer *pHandle)

SBG_INLINE int64_t	sbgStreamBufferReadInt40LE (SbgStreamBuffer *pHandle)

SBG_INLINE int64_t	sbgStreamBufferReadInt48LE (SbgStreamBuffer *pHandle)

SBG_INLINE int64_t	sbgStreamBufferReadInt56LE (SbgStreamBuffer *pHandle)

SBG_INLINE int64_t	sbgStreamBufferReadInt64LE (SbgStreamBuffer *pHandle)

SBG_INLINE size_t	sbgStreamBufferReadSizeT32LE (SbgStreamBuffer *pHandle)

SBG_INLINE size_t	sbgStreamBufferReadSizeT64LE (SbgStreamBuffer *pHandle)

SBG_INLINE SbgErrorCode	sbgStreamBufferReadStringLE (SbgStreamBuffer pHandle, char pString, size_t maxSize)

SBG_INLINE uint16_t	sbgStreamBufferReadUint16LE (SbgStreamBuffer *pHandle)

SBG_INLINE uint32_t	sbgStreamBufferReadUint24LE (SbgStreamBuffer *pHandle)

SBG_INLINE uint32_t	sbgStreamBufferReadUint32LE (SbgStreamBuffer *pHandle)

SBG_INLINE int64_t	sbgStreamBufferReadUint40LE (SbgStreamBuffer *pHandle)

SBG_INLINE uint64_t	sbgStreamBufferReadUint48LE (SbgStreamBuffer *pHandle)

SBG_INLINE uint64_t	sbgStreamBufferReadUint56LE (SbgStreamBuffer *pHandle)

SBG_INLINE uint64_t	sbgStreamBufferReadUint64LE (SbgStreamBuffer *pHandle)

SBG_INLINE SbgErrorCode	sbgStreamBufferWriteDoubleLE (SbgStreamBuffer *pHandle, double value)

SBG_INLINE SbgErrorCode	sbgStreamBufferWriteFloatLE (SbgStreamBuffer *pHandle, float value)

SBG_INLINE SbgErrorCode	sbgStreamBufferWriteInt16LE (SbgStreamBuffer *pHandle, int16_t value)

SBG_INLINE SbgErrorCode	sbgStreamBufferWriteInt24LE (SbgStreamBuffer *pHandle, int32_t value)

SBG_INLINE SbgErrorCode	sbgStreamBufferWriteInt32LE (SbgStreamBuffer *pHandle, int32_t value)

SBG_INLINE SbgErrorCode	sbgStreamBufferWriteInt64LE (SbgStreamBuffer *pHandle, int64_t value)

SBG_INLINE SbgErrorCode	sbgStreamBufferWriteSizeT32LE (SbgStreamBuffer *pHandle, size_t value)

SBG_INLINE SbgErrorCode	sbgStreamBufferWriteSizeT64LE (SbgStreamBuffer *pHandle, size_t value)

SBG_INLINE SbgErrorCode	sbgStreamBufferWriteStringLE (SbgStreamBuffer pHandle, const char pString)

SBG_INLINE SbgErrorCode	sbgStreamBufferWriteUint16LE (SbgStreamBuffer *pHandle, uint16_t value)

SBG_INLINE SbgErrorCode	sbgStreamBufferWriteUint24LE (SbgStreamBuffer *pHandle, uint32_t value)

SBG_INLINE SbgErrorCode	sbgStreamBufferWriteUint32LE (SbgStreamBuffer *pHandle, uint32_t value)

SBG_INLINE SbgErrorCode	sbgStreamBufferWriteUint64LE (SbgStreamBuffer *pHandle, uint64_t value)

Detailed Description

Specific method of stream buffer for little endian readings/writings.

Author: SBG Systems (Maxime Renaudet)

Date: 17 February 2015

Copyright Notice

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 sbgStreamBufferLE.h.

Function Documentation

SBG_INLINE double sbgStreamBufferReadDoubleLE ( SbgStreamBuffer * pHandle )

Read an double from a stream buffer (Little endian version).

Parameters

[in] pHandle Valid stream buffer handle that supports read operations.

Returns: The read value or 0 if we have an error.

Definition at line 1135 of file sbgStreamBufferLE.h.

SBG_INLINE float sbgStreamBufferReadFloatLE ( SbgStreamBuffer * pHandle )

Read an float from a stream buffer (Little endian version).

Parameters

[in] pHandle Valid stream buffer handle that supports read operations.

Returns: The read value or 0 if we have an error.

Definition at line 1086 of file sbgStreamBufferLE.h.

SBG_INLINE int16_t sbgStreamBufferReadInt16LE ( SbgStreamBuffer * pHandle )

Read an int16_t from a stream buffer (Little endian version).

Parameters

[in] pHandle Valid stream buffer handle that supports read operations.

Returns: The read value or 0 if we have an error.

Definition at line 35 of file sbgStreamBufferLE.h.

SBG_INLINE int32_t sbgStreamBufferReadInt24LE ( SbgStreamBuffer * pHandle )

Read an int24 from a stream buffer (Little endian version).

Parameters

[in] pHandle Valid stream buffer handle that supports read operations.

Returns: The read value or 0 if we have an error.

Definition at line 177 of file sbgStreamBufferLE.h.

SBG_INLINE int32_t sbgStreamBufferReadInt32LE ( SbgStreamBuffer * pHandle )

Read an int32_t from a stream buffer (Little endian version).

Parameters

[in] pHandle Valid stream buffer handle that supports read operations.

Returns: The read value or 0 if we have an error.

Definition at line 313 of file sbgStreamBufferLE.h.

SBG_INLINE int64_t sbgStreamBufferReadInt40LE ( SbgStreamBuffer * pHandle )

Read an int40 from a stream buffer (Little endian version).

Parameters

[in] pHandle Valid stream buffer handle that supports read operations.

Returns: The read value or 0 if we have an error.

Definition at line 459 of file sbgStreamBufferLE.h.

SBG_INLINE int64_t sbgStreamBufferReadInt48LE ( SbgStreamBuffer * pHandle )

Read an int48 from a stream buffer (Little endian version).

Parameters

[in] pHandle Valid stream buffer handle that supports read operations.

Returns: The read value or 0 if we have an error.

Definition at line 603 of file sbgStreamBufferLE.h.

SBG_INLINE int64_t sbgStreamBufferReadInt56LE ( SbgStreamBuffer * pHandle )

Read an int56 from a stream buffer (Little endian version).

Parameters

[in] pHandle Valid stream buffer handle that supports read operations.

Returns: The read value or 0 if we have an error.

Definition at line 751 of file sbgStreamBufferLE.h.

SBG_INLINE int64_t sbgStreamBufferReadInt64LE ( SbgStreamBuffer * pHandle )

Read an int64_t from a stream buffer (Little endian version).

Parameters

[in] pHandle Valid stream buffer handle that supports read operations.

Returns: The read value or 0 if we have an error.

Definition at line 903 of file sbgStreamBufferLE.h.

SBG_INLINE size_t sbgStreamBufferReadSizeT32LE ( SbgStreamBuffer * pHandle )

Read a size_t from a stream buffer that has been stored in a uint32_t (Little endian version).

Parameters

[in] pHandle Valid stream buffer handle that supports read operations.

Returns: The read value or 0 if we have an error.

Definition at line 1047 of file sbgStreamBufferLE.h.

SBG_INLINE size_t sbgStreamBufferReadSizeT64LE ( SbgStreamBuffer * pHandle )

Read a size_t from a stream buffer that has been stored in a uint64_t (Little endian version).

Parameters

[in] pHandle Valid stream buffer handle that supports read operations.

Returns: The read value or 0 if we have an error.

Definition at line 1061 of file sbgStreamBufferLE.h.

SBG_INLINE SbgErrorCode sbgStreamBufferReadStringLE	(	SbgStreamBuffer *	pHandle,
		char *	pString,
		size_t	maxSize
	)

Read a C String from a stream buffer (Little Endian Version).

Parameters

[in]	pHandle	Valid stream buffer handle that supports read operations.
[out]	pString	Buffer that can hold the read NULL terminated C string.
[in]	maxSize	Maximum number of bytes that can be stored in pString (including the NULL char).

Returns: SBG_NO_ERROR if the string has been read successfully from the stream buffer. SBG_BUFFER_OVERFLOW if the provided string isn't big enough to hold the read string

Definition at line 1824 of file sbgStreamBufferLE.h.

SBG_INLINE uint16_t sbgStreamBufferReadUint16LE ( SbgStreamBuffer * pHandle )

Read an uint16_t from a stream buffer (Little endian version).

Parameters

[in] pHandle Valid stream buffer handle that supports read operations.

Returns: The read value or 0 if we have an error.

Definition at line 106 of file sbgStreamBufferLE.h.

SBG_INLINE uint32_t sbgStreamBufferReadUint24LE ( SbgStreamBuffer * pHandle )

Read an uint24 from a stream buffer (Little endian version).

Parameters

[in] pHandle Valid stream buffer handle that supports read operations.

Returns: The read value or 0 if we have an error.

Definition at line 245 of file sbgStreamBufferLE.h.

SBG_INLINE uint32_t sbgStreamBufferReadUint32LE ( SbgStreamBuffer * pHandle )

Read an uint32_t from a stream buffer (Little endian version).

Parameters

[in] pHandle Valid stream buffer handle that supports read operations.

Returns: The read value or 0 if we have an error.

Definition at line 386 of file sbgStreamBufferLE.h.

SBG_INLINE int64_t sbgStreamBufferReadUint40LE ( SbgStreamBuffer * pHandle )

Read an uint40 from a stream buffer (Little endian version).

Parameters

[in] pHandle Valid stream buffer handle that supports read operations.

Returns: The read value or 0 if we have an error.

Definition at line 531 of file sbgStreamBufferLE.h.

SBG_INLINE uint64_t sbgStreamBufferReadUint48LE ( SbgStreamBuffer * pHandle )

Read an uint48 from a stream buffer (Little endian version).

Parameters

[in] pHandle Valid stream buffer handle that supports read operations.

Returns: The read value or 0 if we have an error.

Definition at line 677 of file sbgStreamBufferLE.h.

SBG_INLINE uint64_t sbgStreamBufferReadUint56LE ( SbgStreamBuffer * pHandle )

Read an uint56 from a stream buffer (Little endian version).

Parameters

[in] pHandle Valid stream buffer handle that supports read operations.

Returns: The read value or 0 if we have an error.

Definition at line 827 of file sbgStreamBufferLE.h.

SBG_INLINE uint64_t sbgStreamBufferReadUint64LE ( SbgStreamBuffer * pHandle )

Read an uint64_t from a stream buffer (Little endian version).

Parameters

[in] pHandle Valid stream buffer handle that supports read operations.

Returns: The read value or 0 if we have an error.

Definition at line 975 of file sbgStreamBufferLE.h.

SBG_INLINE SbgErrorCode sbgStreamBufferWriteDoubleLE	(	SbgStreamBuffer *	pHandle,
		double	value
	)

Write an double into a stream buffer. (Little Endian Version).

Parameters

[in]	pHandle	Valid stream buffer handle that supports write operations.
[in]	value	The value to write.

Returns: SBG_NO_ERROR if the value has been successfully written.

Definition at line 1787 of file sbgStreamBufferLE.h.

SBG_INLINE SbgErrorCode sbgStreamBufferWriteFloatLE	(	SbgStreamBuffer *	pHandle,
		float	value
	)

Write an float into a stream buffer (Little Endian Version).

Parameters

[in]	pHandle	Valid stream buffer handle that supports write operations.
[in]	value	The value to write.

Returns: SBG_NO_ERROR if the value has been successfully written.

Definition at line 1753 of file sbgStreamBufferLE.h.

SBG_INLINE SbgErrorCode sbgStreamBufferWriteInt16LE	(	SbgStreamBuffer *	pHandle,
		int16_t	value
	)

Write an int16_t into a stream buffer (Little Endian Version).

Parameters

[in]	pHandle	Valid stream buffer handle that supports write operations.
[in]	value	The value to write.

Returns: SBG_NO_ERROR if the value has been successfully written.

Definition at line 1189 of file sbgStreamBufferLE.h.

SBG_INLINE SbgErrorCode sbgStreamBufferWriteInt24LE	(	SbgStreamBuffer *	pHandle,
		int32_t	value
	)

Write an int24 into a stream buffer (Little Endian Version).

Parameters

[in]	pHandle	Valid stream buffer handle that supports write operations.
[in]	value	The value to write.

Returns: SBG_NO_ERROR if the value has been successfully written.

Definition at line 1312 of file sbgStreamBufferLE.h.

SBG_INLINE SbgErrorCode sbgStreamBufferWriteInt32LE	(	SbgStreamBuffer *	pHandle,
		int32_t	value
	)

Write an int32_t into a stream buffer (Little Endian Version).

Parameters

[in]	pHandle	Valid stream buffer handle that supports write operations.
[in]	value	The value to write.

Returns: SBG_NO_ERROR if the value has been successfully written.

Definition at line 1434 of file sbgStreamBufferLE.h.

SBG_INLINE SbgErrorCode sbgStreamBufferWriteInt64LE	(	SbgStreamBuffer *	pHandle,
		int64_t	value
	)

Write an int64_t into a stream buffer (Little Endian Version).

Parameters

[in]	pHandle	Valid stream buffer handle that supports write operations.
[in]	value	The value to write.

Returns: SBG_NO_ERROR if the value has been successfully written.

Definition at line 1564 of file sbgStreamBufferLE.h.

SBG_INLINE SbgErrorCode sbgStreamBufferWriteSizeT32LE	(	SbgStreamBuffer *	pHandle,
		size_t	value
	)

Write an size_t into a stream buffer as a uint32_t (Little Endian Version).

Parameters

[in]	pHandle	Valid stream buffer handle that supports write operations.
[in]	value	The value to write.

Returns: SBG_NO_ERROR if the value has been successfully written.

Definition at line 1710 of file sbgStreamBufferLE.h.

SBG_INLINE SbgErrorCode sbgStreamBufferWriteSizeT64LE	(	SbgStreamBuffer *	pHandle,
		size_t	value
	)

Write an size_t into a stream buffer as a uint64_t (Little Endian Version).

Parameters

[in]	pHandle	Valid stream buffer handle that supports write operations.
[in]	value	The value to write.

Returns: SBG_NO_ERROR if the value has been successfully written.

Definition at line 1734 of file sbgStreamBufferLE.h.

SBG_INLINE SbgErrorCode sbgStreamBufferWriteStringLE	(	SbgStreamBuffer *	pHandle,
		const char *	pString
	)

Write a NULL terminated C String into a stream buffer (Little Endian Version).

Parameters

[in]	pHandle	Valid stream buffer handle that supports write operations.
[in]	pString	NULL terminated C String to write to the stream buffer.

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

Definition at line 1868 of file sbgStreamBufferLE.h.

SBG_INLINE SbgErrorCode sbgStreamBufferWriteUint16LE	(	SbgStreamBuffer *	pHandle,
		uint16_t	value
	)

Write an uint16_t into a stream buffer (Little Endian Version).

Parameters

[in]	pHandle	Valid stream buffer handle that supports write operations.
[in]	value	The value to write.

Returns: SBG_NO_ERROR if the value has been successfully written.

Definition at line 1250 of file sbgStreamBufferLE.h.

SBG_INLINE SbgErrorCode sbgStreamBufferWriteUint24LE	(	SbgStreamBuffer *	pHandle,
		uint32_t	value
	)

Write an uint24 into a stream buffer (Little Endian Version).

Parameters

[in]	pHandle	Valid stream buffer handle that supports write operations.
[in]	value	The value to write.

Returns: SBG_NO_ERROR if the value has been successfully written.

Definition at line 1373 of file sbgStreamBufferLE.h.

SBG_INLINE SbgErrorCode sbgStreamBufferWriteUint32LE	(	SbgStreamBuffer *	pHandle,
		uint32_t	value
	)

Write an uint32_t into a stream buffer (Little Endian Version).

Parameters

[in]	pHandle	Valid stream buffer handle that supports write operations.
[in]	value	The value to write.

Returns: SBG_NO_ERROR if the value has been successfully written.

Definition at line 1499 of file sbgStreamBufferLE.h.

SBG_INLINE SbgErrorCode sbgStreamBufferWriteUint64LE	(	SbgStreamBuffer *	pHandle,
		uint64_t	value
	)

Write an uint64_t into a stream buffer (Little Endian Version).

Parameters

[in]	pHandle	Valid stream buffer handle that supports write operations.
[in]	value	The value to write.

Returns: SBG_NO_ERROR if the value has been successfully written.

Definition at line 1637 of file sbgStreamBufferLE.h.

Functions

Detailed Description

Copyright Notice

Function Documentation