Skip to content

Rename RPCs named as StreamX to GetXStream #84

@tiyash-basu-frequenz

Description

@tiyash-basu-frequenz

What's needed?

stream as a verb refers to the act of publishing something. Therefore RPC names following the naming scheme StreamX, e.g., StreamComponentData, are ambigous. E.g., a client invoking stream_component_data could also indicate that the client intends to publish data, instead of consuming data from a stream.

Proposed solution

A more appropriate name would be GetXStream. E.g., the RPC StreamComponentData could be renamed to GetComponentDataStream, removing any ambiguity in the intention of the method.

Edit:
The current consensus is to have PublishX methods to stream data, and SubscribeX methods to consume data from streams.

Use cases

No response

Alternatives and workarounds

No response

Additional context

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    part:protobufAffects the protocol buffer definition filespriority:❓We need to figure out how soon this should be addressedtype:enhancementNew feature or enhancement visitble to users

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions