https://github.com/rticommunity/nano-client
A multi-platform, open-source DDS-XRCE Client API
https://github.com/rticommunity/nano-client
communication databus datacentric dds dds-xrce middleware pubsub
Last synced: 3 months ago
JSON representation
A multi-platform, open-source DDS-XRCE Client API
- Host: GitHub
- URL: https://github.com/rticommunity/nano-client
- Owner: rticommunity
- License: apache-2.0
- Created: 2020-07-08T17:34:01.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-01-16T02:56:29.000Z (over 2 years ago)
- Last Synced: 2024-01-16T07:52:52.009Z (over 2 years ago)
- Topics: communication, databus, datacentric, dds, dds-xrce, middleware, pubsub
- Language: C
- Homepage: https://community.rti.com/static/documentation/nano/nano-client/latest/manual/nano-client/html/
- Size: 550 KB
- Stars: 4
- Watchers: 7
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# RTI nano-client
*RTI nano-client* provides a lightweight, open-source C/C++ API to access any
DDS Global Data Space using the [standard XRCE protocol][omg-xrce].
Consider [*RTI nano-agent*][nano-agent-git]
for a standard-compliant implementation of the XRCE Agent built with
[RTI Connext DDS][connext-home].
This project is part of RTI's [Experimental Projects][experimental-faq].
## DDS-XRCE
![DDS-XRCE System Architecture][dds-xrce-architecture]
Thanks to XRCE, limited devices such as microcontrollers and other embedded
targets can become part of a DDS system.
[DDS-XRCE][omg-xrce] (or "DDS for e*X*tremely *R*esource *C*onstrained *E*nvironments") introduces
an alternative interface to DDS which offloads all management of DDS entities
from applications to an external Agent process.
Applications connect to the XRCE Agent as clients, and they use the
*XRCE Client API* to:
* Create and configure DDS entities on the Agent.
* Write DDS samples using a DataWriter on the Agent.
* Read DDS samples received by a DataReader on the Agent.
XRCE's client/server model significantly reduces the memory
footprint and network bandwidth required by an application to use DDS.
The XRCE protocol may be carried over any transport that has a
Maximum Transmission Unit (MTU) of at least 24 bytes. There are
standard mappings for TCP/UDP sockets, and Serial Transports.
The XRCE standard also defines a reliability protocol for reliable
delivery of messages over unreliable transports. XRCE also supports
fragmentation (and reconstruction) of large data payloads, allowing
XRCE to send data larger than the transport's MTU.
## Documentation
Please refer to the [User Manual][nano-client-docs] for
information on how to install, build, and use *RTI nano-client*.
## License
*RTI nano-client* is released under the terms of the Apache 2.0 license. See the LICENSE file for more information.
```text
(c) 2020 Copyright, Real-Time Innovations, Inc. (RTI)
```
[omg-xrce]: https://www.omg.org/spec/DDS-XRCE/About-DDS-XRCE/ "OMG DDS-XRCE Specification"
[nano-agent-git]: https://github.com/rticommunity/nano-agent.git "RTI nano-agent Git repository"
[nano-client-docs]: https://community.rti.com/static/documentation/nano/nano-client/latest/manual/nano-client/html/ "RTI nano-client User Manual"
[dds-xrce-architecture]: doc/static/dds_xrce_architecture.png "DDS-XRCE System Architecture"
[experimental-faq]: https://www.rti.com/developers/rti-labs/experimental-product-faq "RTI Experimental Product FAQ"
[connext-home]: https://www.rti.com/products/connext-dds-professional "RTI Connext DDS Professional Homepage"