Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation on Error responses seems to be incorrect #66

Open
atheriel opened this issue May 30, 2022 · 0 comments
Open

Documentation on Error responses seems to be incorrect #66

atheriel opened this issue May 30, 2022 · 0 comments
Labels
launcher Related to the launcher

Comments

@atheriel
Copy link
Contributor

The existing API documentation for Error responses has the following table:

Screenshot 2022-05-30 at 15-46-04 5 Launcher Plugin API RStudio Launcher Plugin Software Development Kit 1 0 21

However, in the actual source code the response ID for error messages seems to be hardcoded to zero:

Impl(Type in_responseType, uint64_t in_requestId) :
ResponseType(static_cast<int>(in_responseType)),
RequestId(in_requestId),
ResponseId(
((in_responseType == Type::HEARTBEAT) || (in_responseType == Type::ERROR)) ?
0 : NEXT_RESPONSE_ID.fetch_add(1))

Unless I'm reading this wrong, the docs should be updated to have 0 as the value of responseId instead of Int.

@bschwedler bschwedler added the launcher Related to the launcher label Nov 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
launcher Related to the launcher
Projects
None yet
Development

No branches or pull requests

2 participants