Skip to content

RFC: internal protocol documentation and commitment to backwards compatibility #1964

@whot

Description

@whot

What happened?

This is a request for documenting the input-leap-internal network protocol so basically:

[X11|Wayland] - [input-leapc] ------------[input-leaps] - [ X11|Wayland]
                                  ^ this bit

AFAICT this is protocol_types.{h,cpp} but the documentation there is insufficient to be independently write a compatible server/client. It'd be nice if there was enough protocol documentation that that would be possible - that would include not only the content of the messages but also when they're allowed to be sent, etc.

Second, and going along with that is a commitment to this being a stable protocol with backwards compatibility. I think that's already true anyway, I just don't know if it's a coincidence or an explicit decision.

Having a stable protocol would make it easier to implement alternative clients, lessening the load on the maintainers a bit.

Version

v2.0.0-RC1

Git commit hash (if applicable)

No response

If applicable, where did you install Input Leap from?

n/a

What OSes are you seeing the problem on? (Check all that apply)

Linux

If applicable, are you using Wayland or X11?

No response

What OS versions are you using?

n/a

Relevant log output

No response

Any other information

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions