CURL support via scripting. #160
Open
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
Status: builds, not tested yet.
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)`
* - for CURL_STATUS_PROGRESS, n1 = bytes downloaded, n2 = total bytes,
* - otherwise, n1 = CURL return code, n2 = HTTP result code.
*/
void fetchUrlAsStringAsync(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` and `n2` depend on status type :
* - for CURL_STATUS_PROGRESS, n1 = bytes downloaded, n2 = total bytes,
* - otherwise, n1 = CURL return code, n2 = HTTP result code.
*/
void curlStatus(CurlStatusType type, int n1, int n2, std::string displayname, std::string message);
```
See updated 'example-script.as'
| cmake_dependent_option(RORSERVER_WITH_ANGELSCRIPT "Adds scripting support" ON "TARGET Angelscript::angelscript" OFF) | ||
| cmake_dependent_option(RORSERVER_WITH_CURL "Adds CURL request support (needs AngelScript)" ON "TARGET CURL:libcurl" OFF) |
There was a problem hiding this comment.
This is the cause of CURL not being found
Suggested change
| cmake_dependent_option(RORSERVER_WITH_CURL "Adds CURL request support (needs AngelScript)" ON "TARGET CURL:libcurl" OFF) | |
| cmake_dependent_option(RORSERVER_WITH_CURL "Adds CURL request support (needs AngelScript)" ON "TARGET CURL::libcurl" OFF) |
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.Known issue: the option
RORSERVER_WITH_CURLdoesn't come up in cmake-gui for some reason. @AnotherFoxGuy can you troubleshoot it please?