CURL support via scripting. #160
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Everything looks good far so, just be sure to update https://github.com/RigsOfRods/ror-server/wiki/Scripting-reference |
Per <angelscript.h> // deprecated since 2022-05-04, 2.36.0
To test, run with 'example-script.as' and say "CURL test" in chat!
The new HTTP(S) request API:
```
/**
* Launches a background task, use `curlStatus` callback to monitor progress and receive result.
* @param displayname The "correlation ID" - the label passed to the callback to identify the transfer.
* @remark Callback signature: `curlStatus(curlStatusType, int n1, int n2, string displayname, string message)`
* - CURL_STATUS_PROGRESS: n1 = bytes downloaded, n2 = total bytes, message = empty
* - CURL_STATUS_SUCCESS: n1 = CURL return code, n2 = HTTP result code, message = payload as string
* - CURL_STATUS_FAILURE: n1 = CURL return code, n2 = HTTP result code, message = CURL error string
*/
void curlRequestAsync(std::string url, std::string displayname);
```
The new status reporting callback:
```
enum curlStatusType
{
CURL_STATUS_INVALID,
CURL_STATUS_PROGRESS,
CURL_STATUS_SUCCESS,
CURL_STATUS_FAILURE,
};
/**
* Params `n1`, `n2` and `message` depend on status type :
* - CURL_STATUS_PROGRESS: n1 = bytes downloaded, n2 = total bytes, message = empty
* - CURL_STATUS_SUCCESS: n1 = CURL return code, n2 = HTTP result code, message = payload as string
* - CURL_STATUS_FAILURE: n1 = CURL return code, n2 = HTTP result code, message = CURL error string
*/
void curlStatus(CurlStatusType type, int n1, int n2, std::string displayname, std::string message);
```
|
Wiki updated, commits cleaned up. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Added a CURL request function to scripting API. Please see updated 'example-script.as' for all details.
To test, spin up a server with the example script and say "CURL test" in chat - this sends a GET request to
https://www.rigsofrods.org.