Notes on RPC and message type harmonization

Open
#2 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Domain
compilers

Research direction

Start with the linked forum RFC and the current DSDL specification’s definitions of message and RPC types. Determine whether RPC request and response forms should be unified as message definitions with an optional response type, and document an agreed syntax and compatibility implications.

Written by the indexing model from the issue text.

Description

If the named topic development continues roughly along the lines outlined in this post: https://forum.opencyphal.org/t/rfc-zero-configuration-cyphal-with-named-topics/2376/7?u=pavel.kirienko, then it would be desirable to reflect the unification of topics with RPCs in the DSDL language design. Specifically, right now we have two distinct categories of types: message types and RPC types. The former will stay as-is, while the latter may need to be made a subset of message types, where the request part becomes just an ordinary message definition, and the response part becomes the optional response type of the message.

For example, an ordinary message definition implies that no response type is defined for it:

# Message.1.0
float16 value
@sealed

While messages that prescribe a response (whether mandatory or optional) will contain the additional section at the end:

# Message.1.0
float16 value
@sealed
---
# Message.Response.1.0
float16 response_value
@sealed
Dominant language
No language data
Stars
1
Forks
0
PR merge metrics
No merged PRs in 30d

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from OpenCyphal/dsdl_specification

All issues in OpenCyphal/dsdl_specification

Similar issues

More Compilers issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.