Functions
const bool	kDisableByteSwap (true)

const bool	kEnableByteSwapIfNeeded (false)

PUSH Functions
These functions are used to encode 8/16/32/64-bit fields of NTV2 objects/structs into a byte sequence to send to a remote machine.
void	PUSHU8 (const uint8_t val, RPCBlob &blob)
	Pushes an 8-bit value onto the given byte sequence. More...

void	PUSHU16 (const uint16_t val, RPCBlob &blob, const bool dontSwap=false)
	Pushes a 16-bit value onto the given byte sequence. More...

void	PUSHU32 (const uint32_t val, RPCBlob &blob, const bool dontSwap=false)
	Pushes a 32-bit value onto the given byte sequence. More...

void	PUSHU64 (const uint64_t val, RPCBlob &blob, const bool dontSwap=false)
	Pushes a 64-bit value onto the given byte sequence. More...

POP Functions
These functions are used to decode NTV2 objects/structs from a received byte sequence.
bool	POPU8 (uint8_t &outVal, const RPCBlob &blob, std::size_t &inOutNdx)
	Pops an 8-bit value off the given byte sequence at the given zero-based index position. More...

bool	POPU16 (uint16_t &outVal, const RPCBlob &blob, std::size_t &inOutNdx, const bool dontSwap=false)
	Pops a 16-bit value off the given byte sequence at the given zero-based index position. More...

bool	POPU32 (uint32_t &outVal, const RPCBlob &blob, std::size_t &inOutNdx, const bool dontSwap=false)
	Pops a 32-bit value off the given byte sequence at the given zero-based index position. More...

bool	POPU64 (uint64_t &outVal, const RPCBlob &blob, std::size_t &inOutNdx, const bool dontSwap=false)
	Pops a 64-bit value off the given byte sequence at the given zero-based index position. More...

Function Documentation

◆ kDisableByteSwap()

const bool ntv2nub::kDisableByteSwap ( true )

◆ kEnableByteSwapIfNeeded()

const bool ntv2nub::kEnableByteSwapIfNeeded ( false )

◆ POPU16()

bool ntv2nub::POPU16	(	uint16_t &	outVal,
		const RPCBlob &	blob,
		std::size_t &	inOutNdx,
		const bool	dontSwap = `false`
	)

inline

Pops a 16-bit value off the given byte sequence at the given zero-based index position.

Parameters

[out]	outVal	Receives the 16-bit value popped from the byte sequence. Unchanged if failed.
[in]	blob	The source byte sequence.
[out]	inOutNdx	On entry, contains the zero-based index position in the byte sequence from which the 2 bytes comprising the value will be popped. On exit, contains the index position immediately past the popped 2-byte value.
[in]	dontSwap	If false, the default, the value is byte-swapped after popping; otherwise the value remains in native byte order.

Returns: True if successful; otherwise false.

Definition at line 128 of file ntv2nubtypes.h.

◆ POPU32()

bool ntv2nub::POPU32	(	uint32_t &	outVal,
		const RPCBlob &	blob,
		std::size_t &	inOutNdx,
		const bool	dontSwap = `false`
	)

inline

Pops a 32-bit value off the given byte sequence at the given zero-based index position.

Parameters

[out]	outVal	Receives the 32-bit value popped from the byte sequence. Unchanged if failed.
[in]	blob	The source byte sequence.
[out]	inOutNdx	On entry, contains the zero-based index position in the byte sequence from which the 4 bytes comprising the value will be popped. On exit, contains the index position immediately past the popped 4-byte value.
[in]	dontSwap	If false, the default, the value is byte-swapped after popping; otherwise the value remains in native byte order.

Returns: True if successful; otherwise false.

Definition at line 149 of file ntv2nubtypes.h.

◆ POPU64()

bool ntv2nub::POPU64	(	uint64_t &	outVal,
		const RPCBlob &	blob,
		std::size_t &	inOutNdx,
		const bool	dontSwap = `false`
	)

inline

Pops a 64-bit value off the given byte sequence at the given zero-based index position.

Parameters

[out]	outVal	Receives the 64-bit value popped from the byte sequence. Unchanged if failed.
[in]	blob	The source byte sequence.
[out]	inOutNdx	On entry, contains the zero-based index position in the byte sequence from which the 8 bytes comprising the value will be popped. On exit, contains the index position immediately past the popped 8-byte value.
[in]	dontSwap	If false, the default, the value is byte-swapped after popping; otherwise the value remains in native byte order.

Returns: True if successful; otherwise false.

Definition at line 171 of file ntv2nubtypes.h.

◆ POPU8()

bool ntv2nub::POPU8	(	uint8_t &	outVal,
		const RPCBlob &	blob,
		std::size_t &	inOutNdx
	)

inline

Pops an 8-bit value off the given byte sequence at the given zero-based index position.

Parameters

[out]	outVal	Receives the 8-bit value popped from the byte sequence.
[in]	blob	The source byte sequence.
[out]	inOutNdx	On entry, contains the zero-based index position in the byte sequence from which the one byte comprising the value will be popped. On exit, contains the index position immediately past the popped byte value.

Definition at line 110 of file ntv2nubtypes.h.

◆ PUSHU16()

void ntv2nub::PUSHU16	(	const uint16_t	val,
		RPCBlob &	blob,
		const bool	dontSwap = `false`
	)

inline

Pushes a 16-bit value onto the given byte sequence.

Parameters

[in]	val	The 16-bit value to be appeneded to the byte sequence.
	blob	A non-const reference to the byte sequence to be appended.
[in]	dontSwap	If false, the default, the value is byte-swapped prior to appending, if needed; otherwise it's appended in native byte order.

Definition at line 49 of file ntv2nubtypes.h.

◆ PUSHU32()

void ntv2nub::PUSHU32	(	const uint32_t	val,
		RPCBlob &	blob,
		const bool	dontSwap = `false`
	)

inline

Pushes a 32-bit value onto the given byte sequence.

Parameters

[in]	val	The 32-bit value to be appeneded to the byte sequence.
	blob	A non-const reference to the byte sequence to be appended.
[in]	dontSwap	If false, the default, the value is byte-swapped prior to appending; otherwise it is appended using the native byte-ordering.

Definition at line 63 of file ntv2nubtypes.h.

◆ PUSHU64()

void ntv2nub::PUSHU64	(	const uint64_t	val,
		RPCBlob &	blob,
		const bool	dontSwap = `false`
	)

inline

Pushes a 64-bit value onto the given byte sequence.

Parameters

[in]	val	The 64-bit value to be appeneded to the byte sequence.
	blob	A non-const reference to the byte sequence to be appended.
[in]	dontSwap	If false, the default, the value is byte-swapped prior to appending; otherwise it is appended using the native byte-ordering.

Definition at line 78 of file ntv2nubtypes.h.

◆ PUSHU8()

void ntv2nub::PUSHU8	(	const uint8_t	val,
		RPCBlob &	blob
	)

inline

Pushes an 8-bit value onto the given byte sequence.

Parameters

[in]	val	The 8-bit value to be appeneded to the byte sequence.
	blob	A non-const reference to the byte sequence to be appended.

Definition at line 37 of file ntv2nubtypes.h.

Functions

Function Documentation

◆ kDisableByteSwap()

◆ kEnableByteSwapIfNeeded()

◆ POPU16()

◆ POPU32()

◆ POPU64()

◆ POPU8()

◆ PUSHU16()

◆ PUSHU32()

◆ PUSHU64()

◆ PUSHU8()