session/requestDrive

Experimental

Asks for a loaded session’s drive: granted at once and stopping nothing — when no turn runs, and to another connection while a turn runs or input waits, which run on under the caller (the drive moves and session/driveChanged tells every connection); busy while the caller’s own turn runs or its input waits, while a live holder is idle and its queue cannot be read (no turn/completed is promised then), or for a live holder not opted into experimentalApi while it is not quiet (a result; nothing parked; ask again later, after turn/completed when a turn runs).

Parameters

Type: SessionRequestDriveParams

session/requestDrive params.

Field	Type	Stability	Presence	Description
sessionId	string	Experimental	required	The loaded session whose drive the caller asks for.

Source

schema/msp/experimental/msp.schema.json#/methods/session~2FrequestDrive

{
  "description": "Asks for a loaded session's drive: `granted` at once and stopping nothing — when no turn runs, and to another connection while a turn runs or input waits, which run on under the caller (the drive moves and `session/driveChanged` tells every connection); `busy` while the caller's own turn runs or its input waits, while a live holder is idle and its queue cannot be read (no `turn/completed` is promised then), or for a live holder not opted into `experimentalApi` while it is not quiet (a result; nothing parked; ask again later, after `turn/completed` when a turn runs).",
  "params": {
    "$ref": "#/$defs/SessionRequestDriveParams"
  },
  "result": {
    "$ref": "#/$defs/SessionRequestDriveResult"
  },
  "x-msp-descriptor": "session/requestDrive",
  "x-msp-stability": "experimental"
}