Functions
std::vector< NT_Topic >	nt::GetTopics (NT_Inst inst, std::string_view prefix, unsigned int types)
	Get Published Topics.

std::vector< NT_Topic >	nt::GetTopics (NT_Inst inst, std::string_view prefix, std::span< const std::string_view > types)
	Get Published Topics.

std::vector< TopicInfo >	nt::GetTopicInfo (NT_Inst inst, std::string_view prefix, unsigned int types)
	Get Topic Information about multiple topics.

std::vector< TopicInfo >	nt::GetTopicInfo (NT_Inst inst, std::string_view prefix, std::span< const std::string_view > types)
	Get Topic Information about multiple topics.

TopicInfo	nt::GetTopicInfo (NT_Topic topic)
	Gets Topic Information.

NT_Topic	nt::GetTopic (NT_Inst inst, std::string_view name)
	Gets Topic Handle.

std::string	nt::GetTopicName (NT_Topic topic)
	Gets the name of the specified topic.

NT_Type	nt::GetTopicType (NT_Topic topic)
	Gets the type for the specified topic, or unassigned if non existent.

std::string	nt::GetTopicTypeString (NT_Topic topic)
	Gets the type string for the specified topic, or empty string if non existent.

void	nt::SetTopicPersistent (NT_Topic topic, bool value)
	Sets the persistent property of a topic.

bool	nt::GetTopicPersistent (NT_Topic topic)
	Gets the persistent property of a topic.

void	nt::SetTopicRetained (NT_Topic topic, bool value)
	Sets the retained property of a topic.

bool	nt::GetTopicRetained (NT_Topic topic)
	Gets the retained property of a topic.

void	nt::SetTopicCached (NT_Topic topic, bool value)
	Sets the cached property of a topic.

bool	nt::GetTopicCached (NT_Topic topic)
	Gets the cached property of a topic.

bool	nt::GetTopicExists (NT_Handle handle)
	Determine if topic exists (e.g.

wpi::json	nt::GetTopicProperty (NT_Topic topic, std::string_view name)
	Gets the current value of a property (as a JSON object).

void	nt::SetTopicProperty (NT_Topic topic, std::string_view name, const wpi::json &value)
	Sets a property value.

void	nt::DeleteTopicProperty (NT_Topic topic, std::string_view name)
	Deletes a property.

wpi::json	nt::GetTopicProperties (NT_Topic topic)
	Gets all topic properties as a JSON object.

bool	nt::SetTopicProperties (NT_Topic topic, const wpi::json &update)
	Updates multiple topic properties.

NT_Subscriber	nt::Subscribe (NT_Topic topic, NT_Type type, std::string_view typeStr, const PubSubOptions &options=kDefaultPubSubOptions)
	Creates a new subscriber to value changes on a topic.

void	nt::Unsubscribe (NT_Subscriber sub)
	Stops subscriber.

NT_Publisher	nt::Publish (NT_Topic topic, NT_Type type, std::string_view typeStr, const PubSubOptions &options=kDefaultPubSubOptions)
	Creates a new publisher to a topic.

NT_Publisher	nt::PublishEx (NT_Topic topic, NT_Type type, std::string_view typeStr, const wpi::json &properties, const PubSubOptions &options=kDefaultPubSubOptions)
	Creates a new publisher to a topic.

void	nt::Unpublish (NT_Handle pubentry)
	Stops publisher.

NT_Entry	nt::GetEntry (NT_Topic topic, NT_Type type, std::string_view typeStr, const PubSubOptions &options=kDefaultPubSubOptions)
	Creates a new entry (subscriber and weak publisher) to a topic.

void	nt::ReleaseEntry (NT_Entry entry)
	Stops entry subscriber/publisher.

void	nt::Release (NT_Handle pubsubentry)
	Stops entry/subscriber/publisher.

NT_Topic	nt::GetTopicFromHandle (NT_Handle pubsubentry)
	Gets the topic handle from an entry/subscriber/publisher handle.

Detailed Description

Function Documentation

◆ DeleteTopicProperty()

void nt::DeleteTopicProperty	(	NT_Topic	topic,
		std::string_view	name )

Deletes a property.

Has no effect if the property does not exist.

Parameters

topic	topic handle
name	property name

◆ GetEntry()

NT_Entry nt::GetEntry	(	NT_Topic	topic,
		NT_Type	type,
		std::string_view	typeStr,
		const PubSubOptions &	options = kDefaultPubSubOptions )

Creates a new entry (subscriber and weak publisher) to a topic.

Parameters

topic	topic handle
type	type
typeStr	type string
options	publish options

Returns: Entry handle

◆ GetTopic()

NT_Topic nt::GetTopic	(	NT_Inst	inst,
		std::string_view	name )

Gets Topic Handle.

Returns topic handle.

Parameters

inst	instance handle
name	topic name

Returns: Topic handle.

◆ GetTopicCached()

bool nt::GetTopicCached ( NT_Topic topic )

Gets the cached property of a topic.

Parameters

topic topic handle

Returns: cached property value

◆ GetTopicExists()

bool nt::GetTopicExists ( NT_Handle handle )

Determine if topic exists (e.g.

has at least one publisher).

Parameters

handle Topic, entry, or subscriber handle.

Returns: True if topic exists.

◆ GetTopicFromHandle()

NT_Topic nt::GetTopicFromHandle ( NT_Handle pubsubentry )

Gets the topic handle from an entry/subscriber/publisher handle.

Parameters

pubsubentry entry/subscriber/publisher handle

Returns: Topic handle

◆ GetTopicInfo() [1/3]

std::vector< TopicInfo > nt::GetTopicInfo	(	NT_Inst	inst,
		std::string_view	prefix,
		std::span< const std::string_view >	types )

Get Topic Information about multiple topics.

Returns an array of topic information (handle, name, type, and properties). The results are optionally filtered by string prefix and type to only return a subset of all topics.

Parameters

inst	instance handle
prefix	name required prefix; only topics whose name starts with this string are returned
types	array of type strings

Returns: Array of topic information.

◆ GetTopicInfo() [2/3]

std::vector< TopicInfo > nt::GetTopicInfo	(	NT_Inst	inst,
		std::string_view	prefix,
		unsigned int	types )

Get Topic Information about multiple topics.

Returns an array of topic information (handle, name, type, and properties). The results are optionally filtered by string prefix and type to only return a subset of all topics.

Parameters

inst	instance handle
prefix	name required prefix; only topics whose name starts with this string are returned
types	bitmask of NT_Type values; 0 is treated specially as a "don't care"

Returns: Array of topic information.

◆ GetTopicInfo() [3/3]

TopicInfo nt::GetTopicInfo ( NT_Topic topic )

Gets Topic Information.

Returns information about a topic (name, type, and properties).

Parameters

topic handle

Returns: Topic information.

◆ GetTopicName()

std::string nt::GetTopicName ( NT_Topic topic )

Gets the name of the specified topic.

Returns an empty string if the handle is invalid.

Parameters

topic topic handle

Returns: Topic name

◆ GetTopicPersistent()

bool nt::GetTopicPersistent ( NT_Topic topic )

Gets the persistent property of a topic.

If true, the server retains the topic even when there are no publishers.

Parameters

topic topic handle

Returns: persistent property value

◆ GetTopicProperties()

wpi::json nt::GetTopicProperties ( NT_Topic topic )

Gets all topic properties as a JSON object.

Each key in the object is the property name, and the corresponding value is the property value.

Parameters

topic topic handle

Returns: JSON object

◆ GetTopicProperty()

wpi::json nt::GetTopicProperty	(	NT_Topic	topic,
		std::string_view	name )

Gets the current value of a property (as a JSON object).

Parameters

topic	topic handle
name	property name

Returns: JSON object; null object if the property does not exist.

◆ GetTopicRetained()

bool nt::GetTopicRetained ( NT_Topic topic )

Gets the retained property of a topic.

Parameters

topic topic handle

Returns: retained property value

◆ GetTopics() [1/2]

std::vector< NT_Topic > nt::GetTopics	(	NT_Inst	inst,
		std::string_view	prefix,
		std::span< const std::string_view >	types )

Get Published Topics.

Returns an array of topic handles. The results are optionally filtered by string prefix and type to only return a subset of all topics.

Parameters

inst	instance handle
prefix	name required prefix; only topics whose name starts with this string are returned
types	array of type strings

Returns: Array of topic handles.

◆ GetTopics() [2/2]

std::vector< NT_Topic > nt::GetTopics	(	NT_Inst	inst,
		std::string_view	prefix,
		unsigned int	types )

Get Published Topics.

Returns an array of topic handles. The results are optionally filtered by string prefix and type to only return a subset of all topics.

Parameters

inst	instance handle
prefix	name required prefix; only topics whose name starts with this string are returned
types	bitmask of NT_Type values; 0 is treated specially as a "don't care"

Returns: Array of topic handles.

◆ GetTopicType()

NT_Type nt::GetTopicType ( NT_Topic topic )

Gets the type for the specified topic, or unassigned if non existent.

Parameters

topic topic handle

Returns: Topic type

◆ GetTopicTypeString()

std::string nt::GetTopicTypeString ( NT_Topic topic )

Gets the type string for the specified topic, or empty string if non existent.

This may have more information than the numeric type (especially for raw values).

Parameters

topic topic handle

Returns: Topic type string

◆ Publish()

NT_Publisher nt::Publish	(	NT_Topic	topic,
		NT_Type	type,
		std::string_view	typeStr,
		const PubSubOptions &	options = kDefaultPubSubOptions )

Creates a new publisher to a topic.

Parameters

topic	topic handle
type	type
typeStr	type string
options	publish options

Returns: Publisher handle

◆ PublishEx()

NT_Publisher nt::PublishEx	(	NT_Topic	topic,
		NT_Type	type,
		std::string_view	typeStr,
		const wpi::json &	properties,
		const PubSubOptions &	options = kDefaultPubSubOptions )

Creates a new publisher to a topic.

Parameters

topic	topic handle
type	type
typeStr	type string
properties	initial properties
options	publish options

Returns: Publisher handle

◆ Release()

void nt::Release ( NT_Handle pubsubentry )

Stops entry/subscriber/publisher.

Parameters

pubsubentry entry/subscriber/publisher handle

◆ ReleaseEntry()

void nt::ReleaseEntry ( NT_Entry entry )

Stops entry subscriber/publisher.

Parameters

entry entry handle

◆ SetTopicCached()

void nt::SetTopicCached	(	NT_Topic	topic,
		bool	value )

Sets the cached property of a topic.

If true, the server and clients will store the latest value, allowing the value to be read (and not just accessed through event queues and listeners).

Parameters

topic	topic handle
value	True for cached, false for not cached

◆ SetTopicPersistent()

void nt::SetTopicPersistent	(	NT_Topic	topic,
		bool	value )

Sets the persistent property of a topic.

If true, the stored value is persistent through server restarts.

Parameters

topic	topic handle
value	True for persistent, false for not persistent.

◆ SetTopicProperties()

bool nt::SetTopicProperties	(	NT_Topic	topic,
		const wpi::json &	update )

Updates multiple topic properties.

Each key in the passed-in object is the name of the property to add/update, and the corresponding value is the property value to set for that property. Null values result in deletion of the corresponding property.

Parameters

topic	topic handle
update	JSON object with keys to add/update/delete

Returns: False if update is not a JSON object

◆ SetTopicProperty()

void nt::SetTopicProperty	(	NT_Topic	topic,
		std::string_view	name,
		const wpi::json &	value )

Sets a property value.

Parameters

topic	topic handle
name	property name
value	property value

◆ SetTopicRetained()

void nt::SetTopicRetained	(	NT_Topic	topic,
		bool	value )

Sets the retained property of a topic.

Parameters

topic	topic handle
value	new retained property value

◆ Subscribe()

NT_Subscriber nt::Subscribe	(	NT_Topic	topic,
		NT_Type	type,
		std::string_view	typeStr,
		const PubSubOptions &	options = kDefaultPubSubOptions )

Creates a new subscriber to value changes on a topic.

Parameters

topic	topic handle
type	expected type
typeStr	expected type string
options	subscription options

Returns: Subscriber handle

◆ Unpublish()

void nt::Unpublish ( NT_Handle pubentry )

Stops publisher.

Parameters

pubentry publisher/entry handle

◆ Unsubscribe()

void nt::Unsubscribe ( NT_Subscriber sub )

Stops subscriber.

Parameters

sub	subscriber handle

Functions

Detailed Description

Function Documentation

◆ DeleteTopicProperty()

◆ GetEntry()

◆ GetTopic()

◆ GetTopicCached()

◆ GetTopicExists()

◆ GetTopicFromHandle()

◆ GetTopicInfo() [1/3]

◆ GetTopicInfo() [2/3]

◆ GetTopicInfo() [3/3]

◆ GetTopicName()

◆ GetTopicPersistent()

◆ GetTopicProperties()

◆ GetTopicProperty()

◆ GetTopicRetained()

◆ GetTopics() [1/2]

◆ GetTopics() [2/2]

◆ GetTopicType()

◆ GetTopicTypeString()

◆ Publish()

◆ PublishEx()

◆ Release()

◆ ReleaseEntry()

◆ SetTopicCached()

◆ SetTopicPersistent()

◆ SetTopicProperties()

◆ SetTopicProperty()

◆ SetTopicRetained()

◆ Subscribe()

◆ Unpublish()

◆ Unsubscribe()