Skip to content

pings_get

pings_get is implemented by handlePingsGet in src/api/handlers/pings/pings_get.osl.

Returns pinging messages. The current loop skips entries whose one-based loop index is less than or equal to offset; with offset: 0, the first stored match is skipped.

Gate Requirement
Authentication Required by the central API gate.
Central permission None. Resource, channel, ownership, or hierarchy checks may still apply in the handler/helpers.
Broadcast Not marked global directly by this adapter. A helper may emit focused or server-wide updates.

Every request includes cmd: "pings_get" and may include an opaque listener correlation value.

Field Validation / meaning
limit schema.integer().min(1).max(100).defaultValue(50)
offset schema.integer().min(0).defaultValue(0)

The handler and shared validation path use these OSL schema definitions before normalization:

*schema.Schema schemaPingsGet = schema.object({
limit: schema.integer().min(1).max(100).defaultValue(50),
offset: schema.integer().min(0).defaultValue(0)
})
  1. handleCmd enforces authentication.
  2. dispatchCmd routes pings_get to handlePingsGet.
  3. The adapter validates and normalizes input, then calls its domain collaborators.
  4. Durable mutations complete before the response or event is returned.
  5. onMessage adds the request listener to direct responses and performs any marked broadcast.

Direct collaborators visible in the handler: typeof, inboxMessages, offset, limit, dbMessageToPublic

Response/event command names visible in this adapter: pings_get.

Validation and domain failures use:

{
"cmd": "error",
"val": "<message>",
"src": "pings_get",
"listener": "<copied from request>"
}