SessionReadResult

session/read result. The viewCursor is the fold head at read time — a point-in-time read, immediately stale if a foreign host is appending.

Fields and variants

• history
• pendingRequests
• session
• viewCursor

Source

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

{
  "description": "`session/read` result. The `viewCursor` is the fold head at\nread time — a point-in-time read, immediately stale if a foreign host is\nappending.",
  "properties": {
    "history": {
      "$ref": "#/$defs/SessionHistory",
      "description": "The served history."
    },
    "pendingRequests": {
      "description": "The same pointer shape as `session/resume`. Because `session/read`\nnever subscribes this is a point-in-time log read only: no requests\nare re-issued after it.",
      "items": {
        "$ref": "#/$defs/PendingRequestPointer"
      },
      "type": "array"
    },
    "session": {
      "$ref": "#/$defs/Session",
      "description": "The session as folded point-in-time."
    },
    "viewCursor": {
      "description": "The fold head at read time.",
      "type": "string"
    }
  },
  "required": [
    "history",
    "pendingRequests",
    "session",
    "viewCursor"
  ],
  "type": "object"
}