String Functions

Functions
NT_Bool	NT_SetString (NT_Handle pubentry, int64_t time, const char *value, size_t len)
	Publish a new value. More...
NT_Bool	NT_SetDefaultString (NT_Handle pubentry, const char *defaultValue, size_t defaultValueLen)
	Publish a default value. More...
char *	NT_GetString (NT_Handle subentry, const char *defaultValue, size_t defaultValueLen, size_t *len)
	Get the last published value. More...
void	NT_GetAtomicString (NT_Handle subentry, const char *defaultValue, size_t defaultValueLen, struct NT_TimestampedString *value)
	Get the last published value along with its timestamp. More...
void	NT_DisposeTimestampedString (struct NT_TimestampedString *value)
	Disposes a timestamped value (as returned by NT_GetAtomicString). More...
struct NT_TimestampedString *	NT_ReadQueueString (NT_Handle subentry, size_t *len)
	Get an array of all value changes since the last call to ReadQueue. More...
void	NT_FreeQueueString (struct NT_TimestampedString *arr, size_t len)
	Frees a timestamped array of values (as returned by NT_ReadQueueString). More...

Detailed Description

Function Documentation

NT_DisposeTimestampedString()

void NT_DisposeTimestampedString

(

struct NT_TimestampedString *

value

)

Disposes a timestamped value (as returned by NT_GetAtomicString).

Parameters

value

timestamped value

NT_FreeQueueString()

void NT_FreeQueueString	(	struct NT_TimestampedString *	arr,
		size_t	len
	)

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

Parameters

arr	array
len	length of array

NT_GetAtomicString()

void NT_GetAtomicString	(	NT_Handle	subentry,
		const char *	defaultValue,
		size_t	defaultValueLen,
		struct NT_TimestampedString *	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_GetString()

char * NT_GetString	(	NT_Handle	subentry,
		const char *	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_ReadQueueString()

struct NT_TimestampedString * NT_ReadQueueString	(	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_SetDefaultString()

NT_Bool NT_SetDefaultString	(	NT_Handle	pubentry,
		const char *	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_SetString()

NT_Bool NT_SetString	(	NT_Handle	pubentry,
		int64_t	time,
		const char *	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