Constructor
new Topic()
Extends:
- See:
-
- QoS.topicDefault() to create a default QoS object for a topic
- QoSProvider.getTopicQos() on retreiving an externally topic QoS policy from a QoSProvider.
Extends
Members
inconsistentTopicStatus :module:vortexdds~InconsistentTopicStatus
Get the InconsistentTopicStatus object of the topic.
Type:
name :string
the topic name.
Type:
- string
qos :module:vortexdds.QoS
The existing QoS policies for the entity.
Type:
- Overrides:
typeSupport :module:vortexdds.TypeSupport
the type support for the topic.
Type:
Methods
createStatusCondition(maskopt) → {module:vortexdds.StatusCondition}
Creates a StatusCondition for use in wait set.
Omitting the mask value results in all entity-appropriate status conditions being enabled.
Note that DDS resources and memory consumed by conditions cannot be automatically reclaimed by the NodeJS engine. Conditions are automatically deleted when the parent entity is deleted. Otherwise, when your application is finished with a Condition, you may call Condition.delete() to release these DDS resources.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
mask |
module:vortexdds.StatusMask |
<optional> |
null | mask of StatusMask values of interest |
Throws:
-
if the status mask is invalid
Returns:
delete() → {external:Promise}
Releases the DDS resources associated with the entity and all its 'child' entities.
In some cases, releasing DDS resources can take several seconds. This methods returns a Promise that enables you to do processing after all the resources have been released.
- Overrides:
Returns:
- Type
- external:Promise
statusChanges() → {module:vortexdds.StatusMask}
Return the DDS communication statuses that have changed since this method was last called.
- Overrides:
Returns:
a mask of statuses that have changed