OxygenInstance API

adjustparams(path, func)

Adjust the order of path and func based on their types. This is used to support the do ... end syntax for the routing macros.

Clears all cron job defintions

cleartasks(ct::ServerContext)

Clear any stored repeat task definitions

dynamicfiles(folder::String, mountdir::String; headers::Vector{Pair{String,String}}=[], loadfile::Union{Function,Nothing}=nothing)

Mount all files inside the /static folder (or user defined mount point), but files are re-read on each request. The headers array will get applied to all mounted files

getexternalurl()

Return the external URL of the service

getschema()

Return the current internal schema for this app

internalrequest(req::HTTP.Request; middleware::Vector=[], serialize::Bool=true, catch_errors::Bool=true)

Directly call one of our other endpoints registered with the router, using your own middleware and bypassing any globally defined middleware

mergeschema(route::String, customschema::Dict)

Merge the schema of a specific route

resetstate()

Reset all the internal state variables

serve(; middleware::Vector=[], handler=stream_handler, host="127.0.0.1", port=8080, async=false, parallel=false, serialize=true, catch_errors=true, docs=true, metrics=true, show_errors=true, show_banner=true, docs_path="/docs", schema_path="/schema", external_url=nothing, revise, kwargs...)

Start the webserver with your own custom request handler

serveparallel(; middleware::Vector=[], handler=stream_handler, host="127.0.0.1", port=8080, serialize=true, async=false, catch_errors=true, docs=true, metrics=true, kwargs...)

setschema(customschema::Dict)

Overwrites the entire internal schema

startcronjobs()

Start all the cron cronjobs within their own async task. Each individual task will loop conintually and sleep untill the next time it's suppost to

starttasks()

Start all background repeat tasks

staticfiles(folder::String, mountdir::String; headers::Vector{Pair{String,String}}=[], loadfile::Union{Function,Nothing}=nothing)

Mount all files inside the /static folder (or user defined mount point). The headers array will get applied to all mounted files

stopcronjobs()

Stop each background task by toggling a global reference that all cron jobs reference

stoptasks()

Stop all background repeat tasks

terminate(ctx)

stops the webserver immediately

@cron(expression::String, name::String, func::Function)

This variation provides way manually "name" a registered function. This information is used by the server on startup to log out all cron jobs.

@cron(expression::String, func::Function)

Registers a function with a cron expression. This will extract either the function name or the random Id julia assigns to each lambda function.

@delete(path::String, func::Function)

Used to register a function to a specific endpoint to handle DELETE requests

@dynamicfiles(folder::String, mountdir::String, headers::Vector{Pair{String,String}}=[])

Mount all files inside the /static folder (or user defined mount point), but files are re-read on each request

@get(path::String, func::Function)

Used to register a function to a specific endpoint to handle GET requests

@patch(path::String, func::Function)

Used to register a function to a specific endpoint to handle PATCH requests

@post(path::String, func::Function)

Used to register a function to a specific endpoint to handle POST requests

@put(path::String, func::Function)

Used to register a function to a specific endpoint to handle PUT requests

@repeat(interval::Real, name::String, func::Function)

This variation provides way manually "name" a registered repeat task. This information is used by the server on startup to log out all cron jobs.

@repeat(interval::Real, func::Function)

Registers a repeat task. This will extract either the function name or the random Id julia assigns to each lambda function.

@route(methods::Array{String}, path::String, func::Function)

Used to register a function to a specific endpoint to handle mulitiple request types

@staticfiles(folder::String, mountdir::String, headers::Vector{Pair{String,String}}=[])

Mount all files inside the /static folder (or user defined mount point)

@stream(path::String, func::Function)

Used to register a function to a specific endpoint to handle Streaming requests

@websocket(path::String, func::Function)

Used to register a function to a specific endpoint to handle WebSocket connections