$ cyclonedds performance --help
Usage: cyclonedds performance [OPTIONS] COMMAND [ARGS]...
Run CycloneDDS performance tests on your system.
Examples
cyclonedds performance publish--size1000cyclonedds performance subscribe
- basic throughput test with 1024-byte samples
cyclonedds performance ping cyclonedds performance pong
- basic latency test
╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│--topic-T[KS|K32|K256|OU|UK16|UK1024|S16|S256|S4k|S32 Topic (KS is default). Print topic │
│k] information with cyclonedds performance │
│topics│
│--num-keys-nINTEGER Number of key values to use for data (only │
│ for topics with a key value) │
│--unreliable-u Use best-effort instead of reliable │
│--keep-k<all,n> Keep-all or keep-last-N for data (ping/pong │
│ is always keep-last-1) │
│--cpu-c Subscribe to CPU stats from peers and show │
│ them │
│--device-load-d<device:bandwidth> Report network load for device DEV with │
│ nominal bandwidth BW in bits/s (e.g., │
│ eth0:1e9) │
│--duration-DTIMEDELTA Set max duration, integer number of seconds │
│ or timestring like '1h23m11s' │
│--local-matching-L Allow matching with endpoints in the same │
│ process to get throughput/latency in the same │
│ ddsperf process │
│--success-criterion-QTEXT Set success criteria rss:X% max allowed │
│ increase in RSS, in %, rss:X max allowed │
│ increase in RSS, in MB, samples:N min │
│ received messages by "sub", roundtrips:N min │
│ roundtrips for "pong", minmatch:N require >= │
│N matching participants, initwait:DUR wait │
│ for those participants before starting, abort │
│ if not within DUR seconds, maxwait:DUR│
│ require those participants to match within │
│DUR seconds, │
│--reference-time-R<TREF> Show timestamps in the output relative to │
│TREF instead of process start │
│--wait-match-max-WTIMEDELTA Maximum waittime for the minimum required │
│ number of matching participants (set by │
│-Qminmatch:N) to show up before starting │
│ reading/writing data, terminate with an error │
│ otherwise. This differs from -Qmaxwait:DUR│
│ because that doesn't delay starting and │
│ doesn't terminate the process before doing │
│ anything │
│--domain-id-i<ID> Use domain ID instead of the default domain │
│--color[auto|standard|256|truecolor|windows|none] Force the command to output with/without │
│ terminal colors. By default output colours if │
│ the terminal supports it." See the Rich │
│documentation for more info on what the │
│ options mean. │
│--help-h Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ping Send pings │
│pong Send pongs │
│publish Publish data │
│subscribe Subscribe to data │
│topics Show information about the performance topic types. │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯