QCherry: Document asynchronous server-side HTTP API

2026-08-24T12:48:50Z

Document asynchronous server-side HTTP API

New page

= abortRemoteRequest =
Requests cancellation of an HTTP request owned by the current server-side resource.

== Syntax ==
<syntaxhighlight lang="lua">
bool abortRemoteRequest(number requestId)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>requestId</code> || <code>number</code> || yes || The identifier returned by <code>requestRemote</code>.
|}

== Returns ==
Returns <code>true</code> when the owned request exists and cancellation was requested; otherwise returns <code>false</code>.

== Examples ==
Cancel a request that is no longer needed:
<syntaxhighlight lang="lua" line>
local requestId = requestRemote(url, function(body, info)
if info.aborted then
outputDebugString("Request cancelled")
end
end)

if requestId then
abortRemoteRequest(requestId)
end
</syntaxhighlight>

== Notes ==
* Available only in server-side resource scripts.
* A resource can cancel only its own requests.
* Cancellation is cooperative. The completion callback is still delivered with <code>info.aborted = true</code> when the resource remains running.
* Stopping a resource cancels all HTTP requests owned by that resource and discards their callbacks.

[[Category:Lua Functions]]
[[Category:Server Functions]]
[[Category:Utility Functions]]
[[Category:HTTP Functions]]

AbortRemoteRequest - Revision history

QCherry: Document asynchronous server-side HTTP API