StringArray Functions

Functions
NT_Bool	NT_SetStringArray (NT_Handle pubentry, int64_t time, const struct NT_String *value, size_t len)
	Publish a new value. More...
NT_Bool	NT_SetDefaultStringArray (NT_Handle pubentry, const struct NT_String *defaultValue, size_t defaultValueLen)
	Publish a default value. More...
struct NT_String *	NT_GetStringArray (NT_Handle subentry, const struct NT_String *defaultValue, size_t defaultValueLen, size_t *len)
	Get the last published value. More...
void	NT_GetAtomicStringArray (NT_Handle subentry, const struct NT_String *defaultValue, size_t defaultValueLen, struct NT_TimestampedStringArray *value)
	Get the last published value along with its timestamp. More...
void	NT_DisposeTimestampedStringArray (struct NT_TimestampedStringArray *value)
	Disposes a timestamped value (as returned by NT_GetAtomicStringArray). More...
struct NT_TimestampedStringArray *	NT_ReadQueueStringArray (NT_Handle subentry, size_t *len)
	Get an array of all value changes since the last call to ReadQueue. More...
void	NT_FreeQueueStringArray (struct NT_TimestampedStringArray *arr, size_t len)
	Frees a timestamped array of values (as returned by NT_ReadQueueStringArray). More...

Detailed Description

Function Documentation

NT_DisposeTimestampedStringArray()

void NT_DisposeTimestampedStringArray

(

struct NT_TimestampedStringArray *

value

)

Disposes a timestamped value (as returned by NT_GetAtomicStringArray).

Parameters

value

timestamped value

NT_FreeQueueStringArray()

void NT_FreeQueueStringArray	(	struct NT_TimestampedStringArray *	arr,
		size_t	len
	)

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

Parameters

arr	array
len	length of array

NT_GetAtomicStringArray()

void NT_GetAtomicStringArray	(	NT_Handle	subentry,
		const struct NT_String *	defaultValue,
		size_t	defaultValueLen,
		struct NT_TimestampedStringArray *	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_GetStringArray()

struct NT_String * NT_GetStringArray	(	NT_Handle	subentry,
		const struct NT_String *	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_ReadQueueStringArray()

struct NT_TimestampedStringArray * NT_ReadQueueStringArray	(	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_SetDefaultStringArray()

NT_Bool NT_SetDefaultStringArray	(	NT_Handle	pubentry,
		const struct NT_String *	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_SetStringArray()

NT_Bool NT_SetStringArray	(	NT_Handle	pubentry,
		int64_t	time,
		const struct NT_String *	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