Skip to content

LogGapParams

Experimental

log/gap notification params: the raw-altitude shape of the shared gap contract, per subscription. The client MUST fill (after, next) with log/page before treating its fold as current, except for an overFrame gap (see [LogGapReason]).

  • after — Experimental
  • next — Experimental
  • reason — Experimental
  • stream — Experimental
  • subscriptionId — Experimental
Source

schema/msp/experimental/msp.schema.json#/types/LogGapParams

{
"description": "`log/gap` notification params: the raw-altitude shape of the\nshared gap contract, per subscription. The client MUST fill\n`(after, next)` with `log/page` before treating its fold as current,\nexcept for an `overFrame` gap (see [`LogGapReason`]).",
"properties": {
"after": {
"$ref": "#/$defs/RecordPosition",
"description": "The last position the subscription delivered or named."
},
"next": {
"$ref": "#/$defs/RecordPosition",
"description": "`replayAnchorLost`: the first position it will deliver. `overFrame`:\nthe skipped record itself when its position is readable, else the\nnext record it delivers (ADR 58371 D8)."
},
"reason": {
"$ref": "#/$defs/LogGapReason",
"description": "Why the gap opened; absent from hosts that predate it."
},
"stream": {
"$ref": "#/$defs/StreamRef",
"description": "The gapped stream."
},
"subscriptionId": {
"description": "The gapped subscription.",
"type": "integer"
}
},
"required": [
"after",
"next",
"stream",
"subscriptionId"
],
"type": "object",
"x-msp-descriptor": "log/gap",
"x-msp-stability": "experimental"
}