Document the scripting RPC server protocol #815
Draft
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR partially addresses the goals of issue #718.
The document is an outline that aims to thoroughly describe the RPC protocol and how it should be interacted with.
There are some details in the RPC server implementation that may be easy to miss or misunderstand by reading the code on its own.
At the moment this is a rough draft that simply outlines 'what is out there.' It will need to be updated before being complete.
Things that may need to be done:
SendKey
&SendSignal
(SendKey & SendSignal over rpc server #601)