asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

doc: Add documentation for JSONRPC class

Browse source 
(cherry picked from commit 3fc5646b98)
This commit is contained in:
Iced Quinn 2021-06-05 14:30:18 -05:00 committed by Rémi Verschelde
parent 63581fccc3
commit c5f01173a4
No known key found for this signature in database
GPG key ID: C3336907360768E1
1 changed files with 20 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
doc/classes/JSONRPC.xml
View file

@ -1,8 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="JSONRPC" inherits="Object" version="3.4">
<brief_description>
A helper to handle dictionaries which look like JSONRPC documents.
</brief_description>
<description>
[url=https://www.jsonrpc.org/]JSON-RPC[/url] is a standard which wraps a method call in a [JSON] object. The object has a particular structure and identifies which method is called, the parameters to that function, and carries an ID to keep track of responses. This class implements that standard on top of [Dictionary]; you will have to convert between a [Dictionary] and [JSON] with other functions.
</description>
<tutorials>
</tutorials>
@ -12,6 +14,9 @@
<argument index="0" name="method" type="String" />
<argument index="1" name="params" type="Variant" />
<description>
Returns a dictionary in the form of a JSON-RPC notification. Notifications are one-shot messages which do not expect a response.
- [code]method[/code]: Name of the method being called.
- [code]params[/code]: An array or dictionary of parameters being passed to the method.
</description>
</method>
<method name="make_request">
@ -20,6 +25,10 @@
<argument index="1" name="params" type="Variant" />
<argument index="2" name="id" type="Variant" />
<description>
Returns a dictionary in the form of a JSON-RPC request. Requests are sent to a server with the expectation of a response. The ID field is used for the server to specify which exact request it is responding to.
- [code]method[/code]: Name of the method being called.
- [code]params[/code]: An array or dictionary of parameters being passed to the method.
- [code]id[/code]: Uniquely identifies this request. The server is expected to send a response with the same ID.
</description>
</method>
<method name="make_response">
@ -27,6 +36,9 @@
<argument index="0" name="result" type="Variant" />
<argument index="1" name="id" type="Variant" />
<description>
When a server has received and processed a request, it is expected to send a response. If you did not want a response then you need to have sent a Notification instead.
- [code]result[/code]: The return value of the function which was called.
- [code]id[/code]: The ID of the request this response is targeted to.
</description>
</method>
<method name="make_response_error" qualifiers="const">
@ -35,6 +47,10 @@
<argument index="1" name="message" type="String" />
<argument index="2" name="id" type="Variant" default="null" />
<description>
Creates a response which indicates a previous reply has failed in some way.
- [code]code[/code]: The error code corresponding to what kind of error this is. See the [enum ErrorCode] constants.
- [code]message[/code]: A custom message about this error.
- [code]id[/code]: The request this error is a response to.
</description>
</method>
<method name="process_action">
@ -42,6 +58,9 @@
<argument index="0" name="action" type="Variant" />
<argument index="1" name="recurse" type="bool" default="false" />
<description>
Given a Dictionary which takes the form of a JSON-RPC request: unpack the request and run it. Methods are resolved by looking at the field called "method" and looking for an equivalently named function in the JSONRPC object. If one is found that method is called.
To add new supported methods extend the JSONRPC class and call [method process_action] on your subclass.
[code]action[/code]: The action to be run, as a Dictionary in the form of a JSON-RPC request or notification.
</description>
</method>
<method name="process_string">
@ -64,6 +83,7 @@
<constant name="INVALID_REQUEST" value="-32600" enum="ErrorCode">
</constant>
<constant name="METHOD_NOT_FOUND" value="-32601" enum="ErrorCode">
A method call was requested but no function of that name existed in the JSONRPC subclass.
</constant>
<constant name="INVALID_PARAMS" value="-32602" enum="ErrorCode">
</constant>