API Reference Tornex v#0.3.0

View Source

Modules

Core API functionality.

The behaviours of HTTP client implementations for Tornex.API.get/1.

The built-in HTTP client for Tornex.API.get/1.

PromEx plugin for Tornex to export events and metrics to Prometheus.

The query struct containing API request data.

Representation of a user's bucket for API requests used for rate-limiting and prioritization.

Default supervisor to supervise Tornex.Scheduler.Bucket, the dump timer, and the bucket registry. The Supervisor can be replaced if necessary to modify bucket storage, the dump timer, etc.

Timer used to determine when to dump all of the buckets, see Tornex.Scheduler.Bucket. By default, the bucket will be dumped every 15 seconds to allow for a maximum call rate of 60 API requests per minute. Upon the dump timer ending, the GenServer will send a :dump signal to all Tornex.Scheduler.Bucket under Tornex.Scheduler.Supervisor.

The query struct containing API request data for API v2 requests.

Telemetry for Tornex using :telemetry.