Fast-DDS icon indicating copy to clipboard operation
Fast-DDS copied to clipboard

[20575] Examples refactor: Configuration

Open JesusPoderoso opened this issue 2 years ago • 6 comments

Description

This PR is part of a suite of PR which would make a refactor in the repository examples. It is intended to apply to most of the examples, by making them homogeneous, more understandable, and more specific to the case they were meant to be.

In this configuration example, the key changes are:

  • include also dataReader/Writer profile name as args
  • include LargeData as an option (builtin transport argument)
  • include ALL previous QoS examples:
    • Deadline
    • Disable positive ACKs
    • Lifespan
    • Liveliness
    • Ownership (strength)
    • Partitions
  • Implement all callbacks

The following changes apply to this and the remain examples:

  • remove the DDS prefix from the binaries
  • snake case in binary names and directory names
  • launch only one endpoint per binary (always running them in different shells)
  • unify args names and utility
  • write proper README.md with the purpose of the example and expected inputs, outputs, behavior… (do not include options in readme → enhance user to run --help )
  • implement listener callback in the same class (inheritance)
  • include initialization ( init() ) methods in the constructors
  • improve parsing options to be a black box to the user

Contributor Checklist

  • [x] Commit messages follow the project guidelines.
  • [x] The code follows the style guidelines of this project.
  • [x] Tests that thoroughly check the new feature have been added/Regression tests checking the bug and its fix have been added; the added tests pass locally
  • [x] Any new/modified methods have been properly documented using Doxygen.
  • [x] Changes are ABI compatible.
  • [x] Changes are API compatible.
  • [x] New feature has been added to the versions.md file (if applicable).
  • N/A New feature has been documented/Current behavior is correctly described in the documentation.
  • N/A Applicable backports have been included in the description.

Reviewer Checklist

  • [x] The PR has a milestone assigned.
  • [x] The title and description correctly express the PR's purpose.
  • [x] Check contributor checklist is correct.
  • [ ] Check CI results: changes do not issue any warning.
  • [ ] Check CI results: failing tests are unrelated with the changes.

JesusPoderoso avatar Mar 15 '24 17:03 JesusPoderoso

  • [x] TODO rebase and update versions once hello world example has been merged
  • #4547

JesusPoderoso avatar Apr 08 '24 14:04 JesusPoderoso

@richiprosima please test_3 this

JesusPoderoso avatar May 17 '24 16:05 JesusPoderoso

@richiprosima please test linux please test windows

JesusPoderoso avatar May 21 '24 12:05 JesusPoderoso

@richiprosima please test_3 windows

elianalf avatar May 22 '24 08:05 elianalf

@richiprosima please test_3 linux

elianalf avatar May 22 '24 08:05 elianalf

@richiprosima test windows

elianalf avatar May 22 '24 12:05 elianalf

@richiprosima please test_3 linux please test_3 windows

JesusPoderoso avatar May 27 '24 06:05 JesusPoderoso

@JesusPoderoso would you mind rebasing so that Ubuntu CI and Docs pass CI ?

Mario-DL avatar May 29 '24 07:05 Mario-DL

@richiprosima please test_3 this

JesusPoderoso avatar May 29 '24 08:05 JesusPoderoso