Raw Functions

Functions
NT_Bool	NT_SetRaw (NT_Handle pubentry, int64_t time, const uint8_t *value, size_t len)
	Publish a new value. More...
NT_Bool	NT_SetDefaultRaw (NT_Handle pubentry, const uint8_t *defaultValue, size_t defaultValueLen)
	Publish a default value. More...
uint8_t *	NT_GetRaw (NT_Handle subentry, const uint8_t *defaultValue, size_t defaultValueLen, size_t *len)
	Get the last published value. More...
void	NT_GetAtomicRaw (NT_Handle subentry, const uint8_t *defaultValue, size_t defaultValueLen, struct NT_TimestampedRaw *value)
	Get the last published value along with its timestamp. More...
void	NT_DisposeTimestampedRaw (struct NT_TimestampedRaw *value)
	Disposes a timestamped value (as returned by NT_GetAtomicRaw). More...
struct NT_TimestampedRaw *	NT_ReadQueueRaw (NT_Handle subentry, size_t *len)
	Get an array of all value changes since the last call to ReadQueue. More...
void	NT_FreeQueueRaw (struct NT_TimestampedRaw *arr, size_t len)
	Frees a timestamped array of values (as returned by NT_ReadQueueRaw). More...

Detailed Description

Function Documentation

NT_DisposeTimestampedRaw()

void NT_DisposeTimestampedRaw

(

struct NT_TimestampedRaw *

value

)

Disposes a timestamped value (as returned by NT_GetAtomicRaw).

Parameters

value

timestamped value

NT_FreeQueueRaw()

void NT_FreeQueueRaw	(	struct NT_TimestampedRaw *	arr,
		size_t	len
	)

Frees a timestamped array of values (as returned by NT_ReadQueueRaw).

Parameters

arr	array
len	length of array

NT_GetAtomicRaw()

void NT_GetAtomicRaw	(	NT_Handle	subentry,
		const uint8_t *	defaultValue,
		size_t	defaultValueLen,
		struct NT_TimestampedRaw *	value
	)

Get the last published value along with its timestamp.

If no value has been published, returns the passed defaultValue and a timestamp of 0.

Parameters

subentry	subscriber or entry handle
defaultValue	default value to return if no value has been published
defaultValueLen	length of default value
value	timestamped value (output)

NT_GetRaw()

uint8_t * NT_GetRaw	(	NT_Handle	subentry,
		const uint8_t *	defaultValue,
		size_t	defaultValueLen,
		size_t *	len
	)

Get the last published value.

If no value has been published, returns the passed defaultValue.

Parameters

subentry	subscriber or entry handle
defaultValue	default value to return if no value has been published
defaultValueLen	length of default value
len	length of returned value (output)

Returns

value

NT_ReadQueueRaw()

struct NT_TimestampedRaw * NT_ReadQueueRaw	(	NT_Handle	subentry,
		size_t *	len
	)

Get an array of all value changes since the last call to ReadQueue.

Also provides a timestamp for each value.

Note

The "poll storage" subscribe option can be used to set the queue depth.

Parameters

subentry	subscriber or entry handle
len	length of returned array (output)

Returns

Array of timestamped values; NULL if no new changes have been published since the previous call.

NT_SetDefaultRaw()

NT_Bool NT_SetDefaultRaw	(	NT_Handle	pubentry,
		const uint8_t *	defaultValue,
		size_t	defaultValueLen
	)

Publish a default value.

On reconnect, a default value will never be used in preference to a published value.

Parameters

pubentry	publisher or entry handle
defaultValue	default value
defaultValueLen	length of default value

NT_SetRaw()

NT_Bool NT_SetRaw	(	NT_Handle	pubentry,
		int64_t	time,
		const uint8_t *	value,
		size_t	len
	)

Publish a new value.

Parameters

pubentry	publisher or entry handle
time	timestamp; 0 indicates current NT time should be used
value	value to publish
len	length of value