Directories
¶
| Path | Synopsis |
|---|---|
|
Package auth implements credential parsing and verification for realtime and REST requests.
|
Package auth implements credential parsing and verification for realtime and REST requests. |
|
Package compatgate implements the known-failures gate for the SDK compatibility harnesses (ably-go, ably-js, ably-ai-transport-js): diffing a harness's per-test JSON results against a checked-in ignore list of tests currently expected to fail, so CI can fail on a genuine regression while staying green on already-tracked gaps.
|
Package compatgate implements the known-failures gate for the SDK compatibility harnesses (ably-go, ably-js, ably-ai-transport-js): diffing a harness's per-test JSON results against a checked-in ignore list of tests currently expected to fail, so CI can fail on a genuine regression while staying green on already-tracked gaps. |
|
Package config supports ably-server's optional TOML config file (--config, DESIGN.md §9).
|
Package config supports ably-server's optional TOML config file (--config, DESIGN.md §9). |
|
Package core implements the per-channel state and per-process channel manager — DESIGN.md §5.1.
|
Package core implements the per-channel state and per-process channel manager — DESIGN.md §5.1. |
|
Package fixtures pre-seeds channels with presence members declared in the config file's [[channels]] section (DESIGN.md §9, §12.5).
|
Package fixtures pre-seeds channels with presence members declared in the config file's [[channels]] section (DESIGN.md §9, §12.5). |
|
Package id generates the identifiers used on the wire (connection IDs, message IDs).
|
Package id generates the identifiers used on the wire (connection IDs, message IDs). |
|
Package logging defines the slog conventions shared by the server and its sibling tools: a TRACE level below slog's DEBUG, level-name parsing for the --log-level flag, and a handler hook that renders the custom level with a readable name.
|
Package logging defines the slog conventions shared by the server and its sibling tools: a TRACE level below slog's DEBUG, level-name parsing for the --log-level flag, and a handler hook that renders the custom level with a readable name. |
|
Package metrics exposes ably-server's process-wide Prometheus metrics (DESIGN.md §10).
|
Package metrics exposes ably-server's process-wide Prometheus metrics (DESIGN.md §10). |
|
Package realtime implements the WebSocket realtime endpoint.
|
Package realtime implements the WebSocket realtime endpoint. |
|
Package rest implements the REST API handlers exposed by ably-server: channel message publish/history/mutation/versions, presence and presence history, annotations, token requests, health/readiness checks, and gated stats stubs.
|
Package rest implements the REST API handlers exposed by ably-server: channel message publish/history/mutation/versions, presence and presence history, annotations, token requests, health/readiness checks, and gated stats stubs. |
|
Package serial implements Ably's lexicographically-sortable timeserial format used for the canonical channel ordering identifier (`ChannelMessage.ChannelSerial`, `Message.Serial`).
|
Package serial implements Ably's lexicographically-sortable timeserial format used for the canonical channel ordering identifier (`ChannelMessage.ChannelSerial`, `Message.Serial`). |
|
Package server assembles the ably-server process: flag/env/config parsing, storage/realtime/REST wiring, HTTP routing, and graceful shutdown.
|
Package server assembles the ably-server process: flag/env/config parsing, storage/realtime/REST wiring, HTTP routing, and graceful shutdown. |
|
Package storage defines the persistence boundary for channel data.
|
Package storage defines the persistence boundary for channel data. |
|
bbolt
Package bbolt is the on-disk storage backend (DESIGN.md §6.2).
|
Package bbolt is the on-disk storage backend (DESIGN.md §6.2). |
|
memory
Package memory is an in-process storage backend for ably-server.
|
Package memory is an in-process storage backend for ably-server. |
|
postgres
Package postgres is the database-backed storage backend used by ably-server's cluster mode (DESIGN.md §6.3, §7.2).
|
Package postgres is the database-backed storage backend used by ably-server's cluster mode (DESIGN.md §6.3, §7.2). |
|
storagetest
Package storagetest exposes a contract-test suite that every storage.ChannelStore implementation should satisfy.
|
Package storagetest exposes a contract-test suite that every storage.ChannelStore implementation should satisfy. |
|
Package tracing wires optional OpenTelemetry trace export, configured entirely through the standard OTEL_* environment variables (DESIGN.md §10).
|
Package tracing wires optional OpenTelemetry trace export, configured entirely through the standard OTEL_* environment variables (DESIGN.md §10). |
Click to show internal directories.
Click to hide internal directories.