Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "RAP/Protocol"
m (→Bounds) |
m (→Introduction) |
||
Line 3: | Line 3: | ||
NOTE: All information within this document is subject to change until further notice. | NOTE: All information within this document is subject to change until further notice. | ||
− | The RAP Protocol is the JSON-based format used within the HTTP-Requests from a RAP-client to a RAP-server. Compared with the previously used JavaScript and HTTP-fields based communication | + | The RAP Protocol is the JSON-based format used within the HTTP-Requests from a RAP-client to a RAP-server. Compared with the previously used JavaScript and HTTP-fields based communication it will provide a number of advantages: |
* It allowes to move all client-specific code from the server to the client. | * It allowes to move all client-specific code from the server to the client. |
Revision as of 07:36, 29 August 2011
Contents
Introduction
NOTE: All information within this document is subject to change until further notice.
The RAP Protocol is the JSON-based format used within the HTTP-Requests from a RAP-client to a RAP-server. Compared with the previously used JavaScript and HTTP-fields based communication it will provide a number of advantages:
- It allowes to move all client-specific code from the server to the client.
- It produces human readable messages, easing debugging.
- It allowes the client to create more informative error messages.
- It allowes to replace either ends as long as they process and create valid RAP-protocol messages.
The protocol is currently beeing developed in CVS HEAD. While not fully implemented, the communication will be mixed between old and new format, e.g. JavaScript-code with embedded JSON-objects. We expect to fully switch to the new format (at least the client-to-server direction) with the 1.5 release.
Protocol Format
The protocol is based on the JSON fromat as described here: [ http://www.json.org/ ]
Message
{ "meta" : MetaObject, "operations" : [ (OperationObject)* ] }
There is one message per request and one per response. (May differ while in development.)
MetaObject
{ "requestCounter" : int }
OperationObject
TODO
Data Type Reference
In addition to the datatypes recognized by JSON itself, the RAP protocol also uses these composed types:
Bounds
[ int left, int top, int witdh, int height ]
Note that left and top may be negative. No value may be null.
Color
[ int red, int green, int blue, int alpha ]
All values are to be between 0 and 255. The alpha value may be ignored by the client unless its 0.