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

#include "sbgStreamBufferCommon.h"

Include dependency graph for sbgStreamBufferBE.h:

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

Functions
SBG_INLINE double	sbgStreamBufferReadDoubleBE (SbgStreamBuffer *pHandle)

SBG_INLINE float	sbgStreamBufferReadFloatBE (SbgStreamBuffer *pHandle)

SBG_INLINE int16_t	sbgStreamBufferReadInt16BE (SbgStreamBuffer *pHandle)

SBG_INLINE int32_t	sbgStreamBufferReadInt24BE (SbgStreamBuffer *pHandle)

SBG_INLINE int32_t	sbgStreamBufferReadInt32BE (SbgStreamBuffer *pHandle)

SBG_INLINE int64_t	sbgStreamBufferReadInt40BE (SbgStreamBuffer *pHandle)

SBG_INLINE int64_t	sbgStreamBufferReadInt48BE (SbgStreamBuffer *pHandle)

SBG_INLINE int64_t	sbgStreamBufferReadInt56BE (SbgStreamBuffer *pHandle)

SBG_INLINE int64_t	sbgStreamBufferReadInt64BE (SbgStreamBuffer *pHandle)

SBG_INLINE size_t	sbgStreamBufferReadSizeT32BE (SbgStreamBuffer *pHandle)

SBG_INLINE size_t	sbgStreamBufferReadSizeT64BE (SbgStreamBuffer *pHandle)

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

SBG_INLINE uint16_t	sbgStreamBufferReadUint16BE (SbgStreamBuffer *pHandle)

SBG_INLINE uint32_t	sbgStreamBufferReadUint24BE (SbgStreamBuffer *pHandle)

SBG_INLINE uint32_t	sbgStreamBufferReadUint32BE (SbgStreamBuffer *pHandle)

SBG_INLINE uint64_t	sbgStreamBufferReadUint40BE (SbgStreamBuffer *pHandle)

SBG_INLINE uint64_t	sbgStreamBufferReadUint48BE (SbgStreamBuffer *pHandle)

SBG_INLINE int64_t	sbgStreamBufferReadUint56BE (SbgStreamBuffer *pHandle)

SBG_INLINE uint64_t	sbgStreamBufferReadUint64BE (SbgStreamBuffer *pHandle)

SBG_INLINE SbgErrorCode	sbgStreamBufferWriteDoubleBE (SbgStreamBuffer *pHandle, double value)

SBG_INLINE SbgErrorCode	sbgStreamBufferWriteFloatBE (SbgStreamBuffer *pHandle, float value)

SBG_INLINE SbgErrorCode	sbgStreamBufferWriteInt16BE (SbgStreamBuffer *pHandle, int16_t value)

SBG_INLINE SbgErrorCode	sbgStreamBufferWriteInt24BE (SbgStreamBuffer *pHandle, int32_t value)

SBG_INLINE SbgErrorCode	sbgStreamBufferWriteInt32BE (SbgStreamBuffer *pHandle, int32_t value)

SBG_INLINE SbgErrorCode	sbgStreamBufferWriteInt64BE (SbgStreamBuffer *pHandle, int64_t value)

SBG_INLINE SbgErrorCode	sbgStreamBufferWriteSizeT32BE (SbgStreamBuffer *pHandle, size_t value)

SBG_INLINE SbgErrorCode	sbgStreamBufferWriteSizeT64BE (SbgStreamBuffer *pHandle, size_t value)

SBG_INLINE SbgErrorCode	sbgStreamBufferWriteStringBE (SbgStreamBuffer pHandle, const char pString)

SBG_INLINE SbgErrorCode	sbgStreamBufferWriteUint16BE (SbgStreamBuffer *pHandle, uint16_t value)

SBG_INLINE SbgErrorCode	sbgStreamBufferWriteUint24BE (SbgStreamBuffer *pHandle, uint32_t value)

SBG_INLINE SbgErrorCode	sbgStreamBufferWriteUint32BE (SbgStreamBuffer *pHandle, uint32_t value)

SBG_INLINE SbgErrorCode	sbgStreamBufferWriteUint64BE (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 sbgStreamBufferBE.h.

Function Documentation

SBG_INLINE double sbgStreamBufferReadDoubleBE ( SbgStreamBuffer * pHandle )

Read an double from a stream buffer (Big 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 sbgStreamBufferBE.h.

SBG_INLINE float sbgStreamBufferReadFloatBE ( SbgStreamBuffer * pHandle )

Read an float from a stream buffer (Big 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 sbgStreamBufferBE.h.

SBG_INLINE int16_t sbgStreamBufferReadInt16BE ( SbgStreamBuffer * pHandle )

Read an int16_t from a stream buffer (Big 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 sbgStreamBufferBE.h.

SBG_INLINE int32_t sbgStreamBufferReadInt24BE ( SbgStreamBuffer * pHandle )

Read an int24 from a stream buffer (Big 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 sbgStreamBufferBE.h.

SBG_INLINE int32_t sbgStreamBufferReadInt32BE ( SbgStreamBuffer * pHandle )

Read an int32_t from a stream buffer (Big 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 sbgStreamBufferBE.h.

SBG_INLINE int64_t sbgStreamBufferReadInt40BE ( SbgStreamBuffer * pHandle )

Read an int40 from a stream buffer (Big 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 sbgStreamBufferBE.h.

SBG_INLINE int64_t sbgStreamBufferReadInt48BE ( SbgStreamBuffer * pHandle )

Read an int48 from a stream buffer (Big 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 sbgStreamBufferBE.h.

SBG_INLINE int64_t sbgStreamBufferReadInt56BE ( SbgStreamBuffer * pHandle )

Read an int56 from a stream buffer (Big 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 sbgStreamBufferBE.h.

SBG_INLINE int64_t sbgStreamBufferReadInt64BE ( SbgStreamBuffer * pHandle )

Read an int64_t from a stream buffer (Big 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 sbgStreamBufferBE.h.

SBG_INLINE size_t sbgStreamBufferReadSizeT32BE ( SbgStreamBuffer * pHandle )

Read a size_t from a stream buffer that has been stored in a uint32_t (Big 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 sbgStreamBufferBE.h.

SBG_INLINE size_t sbgStreamBufferReadSizeT64BE ( SbgStreamBuffer * pHandle )

Read a size_t from a stream buffer that has been stored in a uint64_t (Big 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 sbgStreamBufferBE.h.

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

Read a C String from a stream buffer (Big 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 1823 of file sbgStreamBufferBE.h.

SBG_INLINE uint16_t sbgStreamBufferReadUint16BE ( SbgStreamBuffer * pHandle )

Read an uint16_t from a stream buffer (Big 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 sbgStreamBufferBE.h.

SBG_INLINE uint32_t sbgStreamBufferReadUint24BE ( SbgStreamBuffer * pHandle )

Read an uint24 from a stream buffer (Big 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 sbgStreamBufferBE.h.

SBG_INLINE uint32_t sbgStreamBufferReadUint32BE ( SbgStreamBuffer * pHandle )

Read an uint32_t from a stream buffer (Big 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 sbgStreamBufferBE.h.

SBG_INLINE uint64_t sbgStreamBufferReadUint40BE ( SbgStreamBuffer * pHandle )

Read an uint40 from a stream buffer (Big 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 sbgStreamBufferBE.h.

SBG_INLINE uint64_t sbgStreamBufferReadUint48BE ( SbgStreamBuffer * pHandle )

Read an uint48 from a stream buffer (Big 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 sbgStreamBufferBE.h.

SBG_INLINE int64_t sbgStreamBufferReadUint56BE ( SbgStreamBuffer * pHandle )

Read an uint56 from a stream buffer (Big 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 sbgStreamBufferBE.h.

SBG_INLINE uint64_t sbgStreamBufferReadUint64BE ( SbgStreamBuffer * pHandle )

Read an uint64_t from a stream buffer (Big 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 sbgStreamBufferBE.h.

SBG_INLINE SbgErrorCode sbgStreamBufferWriteDoubleBE	(	SbgStreamBuffer *	pHandle,
		double	value
	)

Write an double into a stream buffer (Big 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 1786 of file sbgStreamBufferBE.h.

SBG_INLINE SbgErrorCode sbgStreamBufferWriteFloatBE	(	SbgStreamBuffer *	pHandle,
		float	value
	)

Write an float into a stream buffer (Big 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 1752 of file sbgStreamBufferBE.h.

SBG_INLINE SbgErrorCode sbgStreamBufferWriteInt16BE	(	SbgStreamBuffer *	pHandle,
		int16_t	value
	)

Write an int16_t into a stream buffer (Big 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 sbgStreamBufferBE.h.

SBG_INLINE SbgErrorCode sbgStreamBufferWriteInt24BE	(	SbgStreamBuffer *	pHandle,
		int32_t	value
	)

Write an int24 into a stream buffer (Big 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 1311 of file sbgStreamBufferBE.h.

SBG_INLINE SbgErrorCode sbgStreamBufferWriteInt32BE	(	SbgStreamBuffer *	pHandle,
		int32_t	value
	)

Write an int32_t into a stream buffer (Big 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 1433 of file sbgStreamBufferBE.h.

SBG_INLINE SbgErrorCode sbgStreamBufferWriteInt64BE	(	SbgStreamBuffer *	pHandle,
		int64_t	value
	)

Write an int64_t into a stream buffer (Big 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 1563 of file sbgStreamBufferBE.h.

SBG_INLINE SbgErrorCode sbgStreamBufferWriteSizeT32BE	(	SbgStreamBuffer *	pHandle,
		size_t	value
	)

Write an size_t into a stream buffer as a uint32_t (Big 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 1709 of file sbgStreamBufferBE.h.

SBG_INLINE SbgErrorCode sbgStreamBufferWriteSizeT64BE	(	SbgStreamBuffer *	pHandle,
		size_t	value
	)

Write an size_t into a stream buffer as a uint64_t (Big 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 1733 of file sbgStreamBufferBE.h.

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

Write a NULL terminated C String into a stream buffer (Big 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 1867 of file sbgStreamBufferBE.h.

SBG_INLINE SbgErrorCode sbgStreamBufferWriteUint16BE	(	SbgStreamBuffer *	pHandle,
		uint16_t	value
	)

Write an uint16_t into a stream buffer (Big 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 sbgStreamBufferBE.h.

SBG_INLINE SbgErrorCode sbgStreamBufferWriteUint24BE	(	SbgStreamBuffer *	pHandle,
		uint32_t	value
	)

Write an uint24 into a stream buffer (Big 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 1372 of file sbgStreamBufferBE.h.

SBG_INLINE SbgErrorCode sbgStreamBufferWriteUint32BE	(	SbgStreamBuffer *	pHandle,
		uint32_t	value
	)

Write an uint32_t into a stream buffer (Big 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 1498 of file sbgStreamBufferBE.h.

SBG_INLINE SbgErrorCode sbgStreamBufferWriteUint64BE	(	SbgStreamBuffer *	pHandle,
		uint64_t	value
	)

Write an uint64_t into a stream buffer (Big 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 1636 of file sbgStreamBufferBE.h.

Functions

Detailed Description

Copyright Notice

Function Documentation