/datum/apiHandler

Handles queries to the Goonhub APIv2

Vars
apiRetryDelay	base delay between query attempts, gets multiplied by attempt number
debug	Is debug logging on? If true, detailed logs for each API request will be logged to debug
emergency_shutoff_counter	how many api errors there have been since a successful one
enabled	Is the api handler available for use? only set to false if we try a bunch of times and still fail
lazy_concurrent_counter	lazy count of how many are up/down
lazy_waiting_counter	number of how many are waiting
maxApiRetries	how many times should a query attempt to run before giving up
Procs
apiError	Build and throw an error exception
debugLogRequest	Log an API request
debugLogResponse	Log an API response
queryAPI	Constructs a query to send to the goonhub web API
retryApiQuery	Retries an API query in the event of failure
trackRecentError	Increments or resets the recent error counter

Var Details

var
apiRetryDelay
–

base delay between query attempts, gets multiplied by attempt number

var
debug
–

Is debug logging on? If true, detailed logs for each API request will be logged to debug

var
emergency_shutoff_counter
–

how many api errors there have been since a successful one

var
enabled
–

Is the api handler available for use? only set to false if we try a bunch of times and still fail

var
lazy_concurrent_counter
–

lazy count of how many are up/down

var
lazy_waiting_counter
–

number of how many are waiting

var
maxApiRetries
–

how many times should a query attempt to run before giving up

Proc Details

proc
apiError
(/list/data, source)

Build and throw an error exception

proc
debugLogRequest
(method, route, body)

Log an API request

@method (string) HTTP method of the request @route (string) URL of the request @body (string) JSON encoded body of the request if applicable

proc
debugLogResponse
(method, route, body, headers, status)

Log an API response

@method (string) HTTP method of the request @route (string) URL of the request @body (string) JSON encoded body of the response @headers (list) Response headers @status (int) Response status code

proc
queryAPI
(/datum/apiRoute/route, attempt)

Constructs a query to send to the goonhub web API

@route (/datum/apiRoute) requested route to call, ex. /datum/apiRoute/players/notes/get @attempt (int) number of times we've attempted this query @return (/datum/apiModel|boolean) model containing parsed data response from api, or boolean indicating success

proc
retryApiQuery
(/datum/apiRoute/route, attempt)

Retries an API query in the event of failure

proc
trackRecentError
(reset)

Increments or resets the recent error counter

@reset (bool) reset the counter (eg successful request)

/datum/apiHandler

Vars

Procs

Var Details

var apiRetryDelay –

var debug –

var emergency_shutoff_counter –

var enabled –

var lazy_concurrent_counter –

var lazy_waiting_counter –

var maxApiRetries –