Class SolveScheduler

Robust scheduler for Grasshopper solves.

Sits between your application code and the underlying compute call, adding:

Configurable scheduling (latest-wins for sliders, queue for jobs)
In-flight cancellation (per-call signal + cancelAll)
Optional response caching for repeated inputs
Lifecycle hooks for UI indicators (start / settle / superseded)
State observability via subscribe()

Multiple schedulers can share a single GrasshopperClient — typically one per UI surface (e.g. one for slider scrubs, one for long-running submits).

Example

const scheduler = client.createScheduler({ mode: 'latest-wins', timeoutMs: 30_000 });

// From a slider handler:
scheduler.solve(definition, tree).then((result) => {
  updateMeshes(result);
}).catch((err) => {
  if (err.code !== 'SUPERSEDED') showError(err);
});

// From a UI binding:
scheduler.subscribe(() => {
  showSpinner = scheduler.isSolving;
});

Index

Constructors

constructor

new SolveScheduler(
    executor: SolveExecutor,
    baseConfig: GrasshopperComputeConfig,
    options?: SolveSchedulerOptions,
): SolveScheduler
Parameters
- executor: SolveExecutor
- baseConfig: GrasshopperComputeConfig
- options: SolveSchedulerOptions = {}
Returns SolveScheduler
- Defined in src/features/grasshopper/scheduler/solve-scheduler.ts:147

Accessors

hasPending

get hasPending(): boolean
Returns boolean
- Defined in src/features/grasshopper/scheduler/solve-scheduler.ts:178

inFlightCount

get inFlightCount(): number
Returns number
- Defined in src/features/grasshopper/scheduler/solve-scheduler.ts:182

isSolving

get isSolving(): boolean
Returns boolean
- Defined in src/features/grasshopper/scheduler/solve-scheduler.ts:174

lastDurationMs

get lastDurationMs(): number | null
Returns number | null
- Defined in src/features/grasshopper/scheduler/solve-scheduler.ts:198

lastError

get lastError(): RhinoComputeError | null
Returns RhinoComputeError | null
- Defined in src/features/grasshopper/scheduler/solve-scheduler.ts:194

lastResult

get lastResult(): GrasshopperComputeResponse | null
Returns GrasshopperComputeResponse | null
- Defined in src/features/grasshopper/scheduler/solve-scheduler.ts:190

queueDepth

get queueDepth(): number
Returns number
- Defined in src/features/grasshopper/scheduler/solve-scheduler.ts:186

Methods

cancelAll

cancelAll(): void
Cancel everything — in-flight and pending.

Returns void
- Defined in src/features/grasshopper/scheduler/solve-scheduler.ts:438

clearCache

clearCache(): void
Returns void
- Defined in src/features/grasshopper/scheduler/solve-scheduler.ts:483

dispose

dispose(): void
Returns void
- Defined in src/features/grasshopper/scheduler/solve-scheduler.ts:491

solve

solve(
    definition: string | Uint8Array<ArrayBufferLike>,
    dataTree: DataTree[],
    options?: { signal?: AbortSignal },
): Promise<GrasshopperComputeResponse>
Schedule a solve. Returns a promise that:
- Resolves with the compute response on success.
- Rejects with RhinoComputeError on failure.
- Rejects with code: ErrorCodes.UNKNOWN_ERROR and message: 'Superseded' when the call was canceled because newer values arrived (latest-wins mode).
Caller-supplied signal cancels just this call (rejects with abort error).
Parameters
- definition: string | Uint8Array<ArrayBufferLike>
- dataTree: DataTree[]
- Optionaloptions: { signal?: AbortSignal }
Returns Promise<GrasshopperComputeResponse>
- Defined in src/features/grasshopper/scheduler/solve-scheduler.ts:234

subscribe(listener: () => void): () => void
Parameters
- listener: () => void
Returns () => void
- Defined in src/features/grasshopper/scheduler/solve-scheduler.ts:206

Class SolveScheduler

Example

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns SolveScheduler

Accessors

hasPending

Returns boolean

inFlightCount

Returns number

isSolving

Returns boolean

lastDurationMs

Returns number | null

lastError

Returns RhinoComputeError | null

lastResult

Returns GrasshopperComputeResponse | null

queueDepth

Returns number

Methods

cancelAll

Returns void

clearCache

Returns void

dispose

Returns void

solve

Parameters

Returns Promise<GrasshopperComputeResponse>

Parameters

Returns () => void

Settings

On This Page