Node.js DCPS API Guide

• 1. Preface
  • 1.1. About the Node.js DCPS API Guide
  • 1.2. Intended Audience
• 2. Introduction
  • 2.1. DDS
• 3. Installation
  • 3.1. Dependencies
    • 3.1.1. Linux 64-bit
    • 3.1.2. Windows 64-bit
      • 3.1.2.1. Python and Visual C++ build tools install
  • 3.2. OpenSplice (OSPL) and Node.js DCPS API Installation
  • 3.3. Installing Node.js DCPS API in a Node.js application
  • 3.4. Examples and Documentation
• 4. Examples
  • 4.1. Example Files
    • 4.1.1. Examples
    • 4.1.2. File Types
  • 4.2. Running Examples
• 5. Node.js API for Vortex DDS
  • 5.1. API Usage Patterns
    • 5.1.1. Asynchronous Aspects of the API
    • 5.1.2. Releasing DDS resources
    • 5.1.3. Exceptions
    • 5.1.4. Key API References
  • 5.2. Participant
  • 5.3. Topic
  • 5.4. Publisher
  • 5.5. Writer
  • 5.6. Subscriber
  • 5.7. Reader
    • 5.7.1. QueryCondition
    • 5.7.2. ReadCondition
  • 5.8. WaitSet
  • 5.9. StatusCondition
  • 5.10. GuardCondition
• 6. Listener
  • 6.1. Attaching a listener to an entity
  • 6.2. Listeners
    • 6.2.1. Topic Entity
    • 6.2.2. Reader Entity
    • 6.2.3. Writer Entity
• 7. Quality of Service (QoS)
  • 7.1. Setting QoS Using QoS Provider XML File
    • 7.1.1. QoS Profile
    • 7.1.2. Applying QoS Profile
  • 7.2. Setting QoS Using Node.js DCPS API Classes
• 8. Topic Generation and Discovery
  • 8.1. Over the Wire Discovery
  • 8.2. Dynamic Generation of Node.js Topic Classes Using IDL and Name
    • 8.2.1. Dynamic Generation
    • 8.2.2. Generated Artifacts
  • 8.3. Limitations of Node.js Support
• 9. Cross Compiling Node.js Applications
  • 9.1. Dependencies on the host machine
  • 9.2. Cross-compile Node.js application
  • 9.3. Compile IDL file into XML document
    • 9.3.1. Invoke ‘compile-idl’ script to generate XML
    • 9.3.2. Invoke IDLPP to generate XML
  • 9.4. Copy Node.js application into target platform
  • 9.5. On the target platform
    • 9.5.1. Prerequisites
      • 9.5.1.1. How to cross-compile Node.js for target platform if Node.js install fails
    • 9.5.2. Run cross-compiled Node.js application on the target
• 10. Contacts & Notices
  • 10.1. Contacts
  • 10.2. Notices

Indices and tables

• Search Page