LogPhysicalSubscribeResult

Experimental

log/physicalSubscribe result.

Fields and variants

• relPath — Experimental
• subscriptionId — Experimental
• tailOffset — Experimental

Source

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

{
  "description": "`log/physicalSubscribe` result.",
  "properties": {
    "relPath": {
      "description": "The followed file, relative to the sessions root.",
      "type": "string"
    },
    "subscriptionId": {
      "description": "Connection-scoped id carried on every notification it produces.",
      "type": "integer"
    },
    "tailOffset": {
      "description": "The file's size at subscribe time. The consumer has caught up once\nits cursor's `byteOffset` (the subscribed `after`, then\n`endOffset + 1` after each line) is at or past it; a half-written\nlast line counts once its `\\n` is written. A size, not a cursor, so\nthe acknowledgement never counts lines (Constitution VII).",
      "type": "integer"
    }
  },
  "required": [
    "relPath",
    "subscriptionId",
    "tailOffset"
  ],
  "type": "object",
  "x-msp-descriptor": "log/physicalSubscribe",
  "x-msp-stability": "experimental"
}