mirror of
https://github.com/ParadiseSS13/Paradise.git
synced 2026-08-27 05:57:24 +01:00
5 lines
4.8 KiB
HTML
5 lines
4.8 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><base href="../../../"><link rel="stylesheet" href="dmdoc.css"><title>/datum/controller/subsystem/http - Space Station 13</title></head><body><header><a href="index.html">Space Station 13</a> - <a href="index.html#modules">Modules</a> - <a href="index.html#types">Types</a> — <a href="datum/controller/subsystem/http.html#var">Var Details</a> - <a href="datum/controller/subsystem/http.html#proc">Proc Details</a></header><main><h1>http <aside>/<a href="datum.html">datum</a>/<a href="datum/controller.html">controller</a>/<a href="datum/controller/subsystem.html">subsystem</a>/<a href="datum/controller/subsystem/http.html">http</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/subsystem/SShttp.dm#L1"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/SShttp.dm 1"></a></h1><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="datum/controller/subsystem/http.html#var/active_async_requests">active_async_requests</a></th><td>List of all async HTTP requests in the processing chain</td></tr><tr><th><a href="datum/controller/subsystem/http.html#var/logging_enabled">logging_enabled</a></th><td>Variable to define if logging is enabled or not. Disabled by default since we know the requests the server is making. Enable with VV if you need to debug requests</td></tr><tr><th><a href="datum/controller/subsystem/http.html#var/total_requests">total_requests</a></th><td>Total requests the SS has processed in a round</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr><tr><th><a href="datum/controller/subsystem/http.html#proc/create_async_request">create_async_request</a></th><td>Async request creator</td></tr><tr><th><a href="datum/controller/subsystem/http.html#proc/make_blocking_request">make_blocking_request</a></th><td>Blocking request creator</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/active_async_requests"><aside class="declaration">var </aside>active_async_requests <aside>– /list/<a href="datum.html">datum</a>/<a href="datum/http_request.html">http_request</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/subsystem/SShttp.dm#L10"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/SShttp.dm 10"></a></h3><p>List of all async HTTP requests in the processing chain</p><h3 id="var/logging_enabled"><aside class="declaration">var </aside>logging_enabled <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/subsystem/SShttp.dm#L12"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/SShttp.dm 12"></a></h3><p>Variable to define if logging is enabled or not. Disabled by default since we know the requests the server is making. Enable with VV if you need to debug requests</p><h3 id="var/total_requests"><aside class="declaration">var </aside>total_requests <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/subsystem/SShttp.dm#L14"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/SShttp.dm 14"></a></h3><p>Total requests the SS has processed in a round</p><h2 id="proc">Proc Details</h2><h3 id="proc/create_async_request"><aside class="declaration">proc </aside>create_async_request<aside>(method, url, body, /list/headers, /<a href="datum.html">datum</a>/callback/proc_callback) <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/subsystem/SShttp.dm#L56"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/SShttp.dm 56"></a></aside></h3><p>Async request creator</p>
|
||
<p>Generates an async request, and adds it to the subsystem's processing list
|
||
These should be used as they do not lock the entire DD process up as they execute inside their own thread pool inside RUSTG</p><h3 id="proc/make_blocking_request"><aside class="declaration">proc </aside>make_blocking_request<aside>(method, url, body, /list/headers) <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/subsystem/SShttp.dm#L85"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/SShttp.dm 85"></a></aside></h3><p>Blocking request creator</p>
|
||
<p>Generates a blocking request, executes it, logs the info then cleanly returns the response
|
||
Exists as a proof of concept, and should never be used</p></main><footer>paradise.dme <a href="https://github.com/ParadiseSS13/Paradise/tree/8a8a00a2a9bec485351e5f219982b7315d3504fa">8a8a00a</a> (master) — <a href="https://github.com/SpaceManiac/SpacemanDMM/blob/master/crates/dmdoc/README.md">dmdoc 1.11.0</a></footer></body></html> |