[22722] Support interfaces for RPC generated code #5622

MiguelCompany · 2025-01-31T12:21:29Z

Description

This adds the generic interfaces that the code generated by Fast DDS Gen for RPC interfaces will use.

Contributor Checklist

Commit messages follow the project guidelines.
The code follows the style guidelines of this project.
N/A: 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
Any new/modified methods have been properly documented using Doxygen.
N/A: Any new configuration API has an equivalent XML API (with the corresponding XSD extension)
NO: Changes are backport compatible: they do NOT break ABI nor change library core behavior.
Changes are API compatible.
New feature has been added to the versions.md file (if applicable).
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

The PR has a milestone assigned.
The title and description correctly express the PR's purpose.
Check contributor checklist is correct.
If this is a critical bug fix, backports to the critical-only supported branches have been requested.
Check CI results: changes do not issue any warning.
Check CI results: failing tests are unrelated with the changes.

Signed-off-by: Miguel Company <[email protected]>

include/fastdds/dds/rpc/interfaces/RpcStatusCode.hpp

include/fastdds/dds/rpc/interfaces/RpcClientReader.hpp

include/fastdds/dds/rpc/interfaces/RpcClientWriter.hpp

include/fastdds/dds/rpc/interfaces/RpcServerReader.hpp

include/fastdds/dds/rpc/interfaces/RpcServerWriter.hpp

mcheiva

Initial EIVA review

…lledException` Signed-off-by: Miguel Company <[email protected]>

…Exception` Signed-off-by: Miguel Company <[email protected]>

Signed-off-by: Miguel Company <[email protected]>

MiguelCompany · 2025-02-06T11:40:52Z

Initial EIVA review

@mcheiva I think I addressed all your comments. Could you re-review?

mcheiva

We reviewed your answers to our comments, and it looks good! :)

Signed-off-by: Miguel Company <[email protected]>

include/fastdds/dds/rpc/interfaces/RpcClientWriter.hpp

include/fastdds/dds/rpc/interfaces/RpcServerWriter.hpp

* Refs #22722. Add RpcException class. Signed-off-by: Miguel Company <[email protected]> * Refs #22722. Add RpcTimeoutException class. Signed-off-by: Miguel Company <[email protected]> * Refs #22722. Add RpcBrokenPipeException class. * Refs #22722. Add RpcOperationError class. Signed-off-by: Miguel Company <[email protected]> * Refs #22722. Add utility include for exceptions. Signed-off-by: Miguel Company <[email protected]> * Refs #22722. Add RpcServerReader template interface. Signed-off-by: Miguel Company <[email protected]> * Refs #22722. Add RpcClientReader template interface. Signed-off-by: Miguel Company <[email protected]> * Refs #22722. Add RpcServerWriter template interface. Signed-off-by: Miguel Company <[email protected]> * Refs #22722. Add RpcClientWriter template interface. Signed-off-by: Miguel Company <[email protected]> * Refs #22722. Add RpcInputFeedCancelledException. Signed-off-by: Miguel Company <[email protected]> * Refs #22722. Add RpcFuture template. Signed-off-by: Miguel Company <[email protected]> * Refs #22722. Rename `RpcInputFeedCancelledException` -> `RpcFeedCancelledException` Signed-off-by: Miguel Company <[email protected]> * Refs #22722. `RpcServerWriter` operations can throw `RpcFeedCancelledException` Signed-off-by: Miguel Company <[email protected]> * Refs #22722. Improve documentation of `RpcClientReader` Signed-off-by: Miguel Company <[email protected]> * Refs #22722. Improve documentation of `RpcClientWriter` Signed-off-by: Miguel Company <[email protected]> * Refs #22722. Avoid DSO export warning on Windows Signed-off-by: Miguel Company <[email protected]> * Refs #22722. Add utility include for interfaces. Signed-off-by: Miguel Company <[email protected]> * Refs #22722. Add missing argument on doxygen documentation. Signed-off-by: Miguel Company <[email protected]> --------- Signed-off-by: Miguel Company <[email protected]>

* Support interfaces for RPC generated code (#5622) * Refs #22722. Add RpcException class. Signed-off-by: Miguel Company <[email protected]> * Refs #22722. Add RpcTimeoutException class. Signed-off-by: Miguel Company <[email protected]> * Refs #22722. Add RpcBrokenPipeException class. * Refs #22722. Add RpcOperationError class. Signed-off-by: Miguel Company <[email protected]> * Refs #22722. Add utility include for exceptions. Signed-off-by: Miguel Company <[email protected]> * Refs #22722. Add RpcServerReader template interface. Signed-off-by: Miguel Company <[email protected]> * Refs #22722. Add RpcClientReader template interface. Signed-off-by: Miguel Company <[email protected]> * Refs #22722. Add RpcServerWriter template interface. Signed-off-by: Miguel Company <[email protected]> * Refs #22722. Add RpcClientWriter template interface. Signed-off-by: Miguel Company <[email protected]> * Refs #22722. Add RpcInputFeedCancelledException. Signed-off-by: Miguel Company <[email protected]> * Refs #22722. Add RpcFuture template. Signed-off-by: Miguel Company <[email protected]> * Refs #22722. Rename `RpcInputFeedCancelledException` -> `RpcFeedCancelledException` Signed-off-by: Miguel Company <[email protected]> * Refs #22722. `RpcServerWriter` operations can throw `RpcFeedCancelledException` Signed-off-by: Miguel Company <[email protected]> * Refs #22722. Improve documentation of `RpcClientReader` Signed-off-by: Miguel Company <[email protected]> * Refs #22722. Improve documentation of `RpcClientWriter` Signed-off-by: Miguel Company <[email protected]> * Refs #22722. Avoid DSO export warning on Windows Signed-off-by: Miguel Company <[email protected]> * Refs #22722. Add utility include for interfaces. Signed-off-by: Miguel Company <[email protected]> * Refs #22722. Add missing argument on doxygen documentation. Signed-off-by: Miguel Company <[email protected]> --------- Signed-off-by: Miguel Company <[email protected]> * Add RPCDDS internal API (#5638) * Refs #22682: Add public interfaces of RPC Entities Signed-off-by: Carlosespicur <[email protected]> * Refs #22682: Add RequestInfo class Signed-off-by: Carlosespicur <[email protected]> * Refs #22682: Add ServiceTypeSupport interface Signed-off-by: Carlosespicur <[email protected]> * Refs #22682: Add Requester/Replier parameter classes Signed-off-by: Carlosespicur <[email protected]> * Refs #22682: Add private headers and implement RPC methods Signed-off-by: Carlosespicur <[email protected]> * Refs #22682: Expose Requester/Replier endpoint getters to public API Signed-off-by: Carlosespicur <[email protected]> * Refs #22682: Add public methods for deleting requester/replier entities Signed-off-by: Carlosespicur <[email protected]> * Refs #22682: Allow calling get_statuscondition method on constant entities Signed-off-by: Carlosespicur <[email protected]> * Refs #22682: Refactor blackbox tests Signed-off-by: Carlosespicur <[email protected]> * Refs #22682: Avoid sample filtering on request topic Signed-off-by: Carlosespicur <[email protected]> * Refs #22682: Fix segFault error due to deleting endpoints manually Signed-off-by: Carlosespicur <[email protected]> * Refs #22682: Fix TCPRequester params Signed-off-by: Carlosespicur <[email protected]> * Refs #22682: Enable type() method for const DataReader objects Signed-off-by: Carlosespicur <[email protected]> * Refs #22682: Add unit tests for Requester/Replier parameters validation Signed-off-by: Carlosespicur <[email protected]> * Refs #22682: Add unit tests for DomainParticipant public API methods Signed-off-by: Carlosespicur <[email protected]> * Refs #22682: Fix test errors. Add service/participant checks and avoid inconsistent statuses when unregister types methods fail Signed-off-by: Carlosespicur <[email protected]> * Refs #22682: Update versions.md Signed-off-by: Carlosespicur <[email protected]> * Refs #22682: Apply suggested changes. Remove RequesterParams/ReplierParams classes Signed-off-by: Carlosespicur <[email protected]> * Refs #22682: Apply suggested changes. Unify parameters in Requester/Replier take/send methods Signed-off-by: Carlosespicur <[email protected]> * Refs #22682: Fix RequesterImpl::send_request related_sample_identity assignment Signed-off-by: Carlosespicur <[email protected]> * Refs #22682: Fix typos Signed-off-by: Carlosespicur <[email protected]> * Refs #22682: Apply suggested changes Signed-off-by: Carlosespicur <[email protected]> * Refs #22682: Apply suggested changes Signed-off-by: Carlosespicur <[email protected]> * Refs #22682: Uncrustify Signed-off-by: Carlosespicur <[email protected]> * Refs #22682: Avoid creating unnecesary RequestReplyContentFilter instances Signed-off-by: Carlosespicur <[email protected]> * Refs #22682: Add suggested changes Signed-off-by: Carlosespicur <[email protected]> * Refs #22682: Apply suggested changes. Add return_load method to Requester/Replier public API Signed-off-by: Carlosespicur <[email protected]> * Refs #22682: Apply suggested changes Signed-off-by: Carlosespicur <[email protected]> * Refs #22682: Apply suggested changes. Blackbox tests classes Signed-off-by: Carlosespicur <[email protected]> * Refs #22682: Apply suggested changes. Update send_reply signature. Signed-off-by: Carlosespicur <[email protected]> * Refs #22682: Fix blackbox tests Signed-off-by: Carlosespicur <[email protected]> * Refs #22682: Fix notation errors in Requester/Replier Signed-off-by: Carlosespicur <[email protected]> * Refs #22682: Fix memory leaks in RequestReplyContentFilterFactory Signed-off-by: Carlosespicur <[email protected]> --------- Signed-off-by: Carlosespicur <[email protected]> * Rename constant to `RPC_STATUS_CODE_OK` Signed-off-by: Miguel Company <[email protected]> * Add definitions for remote exceptions (#5698) * Refs #22917. Add `RemoteExceptionCode_t` enumeration. Signed-off-by: Miguel Company <[email protected]> * Refs #22917. Add `RpcRemomteException`. Signed-off-by: Miguel Company <[email protected]> * Refs #22917. Add remote exceptions. Signed-off-by: Miguel Company <[email protected]> * Refs #22917. Uncrustify. Signed-off-by: Miguel Company <[email protected]> * Refs #22917. Add new exceptions to convenience header. Signed-off-by: Miguel Company <[email protected]> * Refs #22917. Document where the enumeration comes from. Signed-off-by: Miguel Company <[email protected]> * Refs #22917. Add blackbox test. Signed-off-by: Miguel Company <[email protected]> * Refs #22917. Remove Dll API from exceptions. Signed-off-by: Miguel Company <[email protected]> * Refs #22917. Add test that captures exceptions. Signed-off-by: Miguel Company <[email protected]> * Refs #22917. Apply review suggestions. Signed-off-by: Miguel Company <[email protected]> * Refs #22917. Fix typo. Signed-off-by: Miguel Company <[email protected]> --------- Signed-off-by: Miguel Company <[email protected]> * Remove unnecessary validations in Requester and Replier QoS (#5710) Signed-off-by: Carlosespicur <[email protected]> * Remove const in DDS endpoints getters Signed-off-by: Carlosespicur <[email protected]> * Refs #22682: Apply suggested changes Signed-off-by: Carlosespicur <[email protected]> * Refs #22682. Apply suggestions from review. Signed-off-by: Miguel Company <[email protected]> * Refs #22682. Properly apply suggestion. Signed-off-by: Miguel Company <[email protected]> --------- Signed-off-by: Miguel Company <[email protected]> Signed-off-by: Carlosespicur <[email protected]> Co-authored-by: Carlos Espinoza Curto <[email protected]> Co-authored-by: Carlosespicur <[email protected]>

MiguelCompany added 11 commits January 31, 2025 12:04

Refs #22722. Add RpcException class.

bfa0826

Signed-off-by: Miguel Company <[email protected]>

Refs #22722. Add RpcTimeoutException class.

576c2d4

Signed-off-by: Miguel Company <[email protected]>

Refs #22722. Add RpcBrokenPipeException class.

404b75c

Refs #22722. Add RpcOperationError class.

f95f09b

Signed-off-by: Miguel Company <[email protected]>

Refs #22722. Add utility include for exceptions.

2fc5bdd

Signed-off-by: Miguel Company <[email protected]>

Refs #22722. Add RpcServerReader template interface.

2183ead

Signed-off-by: Miguel Company <[email protected]>

Refs #22722. Add RpcClientReader template interface.

e74cd0f

Signed-off-by: Miguel Company <[email protected]>

Refs #22722. Add RpcServerWriter template interface.

78cd26c

Signed-off-by: Miguel Company <[email protected]>

Refs #22722. Add RpcClientWriter template interface.

ee5fa7b

Signed-off-by: Miguel Company <[email protected]>

Refs #22722. Add RpcInputFeedCancelledException.

f6672c4

Signed-off-by: Miguel Company <[email protected]>

Refs #22722. Add RpcFuture template.

d8317a7

Signed-off-by: Miguel Company <[email protected]>

MiguelCompany changed the title ~~[22722] Support interfaces for generated code~~ [22722] Support interfaces for RPC generated code Jan 31, 2025

Carlosespicur approved these changes Feb 4, 2025

View reviewed changes

include/fastdds/dds/rpc/interfaces/RpcStatusCode.hpp Show resolved Hide resolved

MiguelCompany added this to the v3.2.0 milestone Feb 4, 2025