Class ArvoOrchestrator

Orchestrates state machine execution and lifecycle management. Handles machine resolution, state management, event processing and error handling.

Hierarchy (view full)

AbstractArvoEventHandler
- ArvoOrchestrator

Index

Constructors

constructor

new ArvoOrchestrator(params): ArvoOrchestrator
Creates a new orchestrator instance
Parameters
- params: IArvoOrchestrator
  Configuration parameters
Returns ArvoOrchestrator
Throws
Error if machines in registry have different sources
Overrides AbstractArvoEventHandler.constructor
- Defined in src/ArvoOrchestrator/index.ts:75

Properties

`Readonly`executionEngine

executionEngine: IMachineExectionEngine

`Readonly`executionunits

executionunits: number

`Readonly`registry

registry: IMachineRegistry

`Readonly`syncEventResource

syncEventResource: SyncEventResource<MachineMemoryRecord>

`Optional` `Readonly`systemErrorDomain

systemErrorDomain?: (null | string)[] = []

Accessors

domain

get domain(): null | string
Returns null | string
- Defined in src/ArvoOrchestrator/index.ts:66

memory

get memory(): IMachineMemory<MachineMemoryRecord>
Returns IMachineMemory<MachineMemoryRecord>
- Defined in src/ArvoOrchestrator/index.ts:62

requiresResourceLocking

get requiresResourceLocking(): boolean
Returns boolean
- Defined in src/ArvoOrchestrator/index.ts:58

source

get source(): any
Unique identifier for the event handler source system

Returns any
Overrides AbstractArvoEventHandler.source
- Defined in src/ArvoOrchestrator/index.ts:54

systemErrorSchema

get systemErrorSchema(): ArvoContractRecord
Gets the error schema for this orchestrator

Returns ArvoContractRecord
Overrides AbstractArvoEventHandler.systemErrorSchema
- Defined in src/ArvoOrchestrator/index.ts:662

Methods

`Protected`createEmittableEvent

createEmittableEvent(event, machine, otelHeaders, orchestrationParentSubject, sourceEvent, initEventId, _domain): ArvoEvent<Record<string, any>, Record<string,
    | null
    | string
    | number
    | boolean>, string>
Creates emittable event from execution result
Parameters
- event: EnqueueArvoEventActionParam
  Source event to emit
- machine: ArvoMachine<any, any, any, any, any>
  Machine that generated event
- otelHeaders: OpenTelemetryHeaders
  OpenTelemetry headers
- orchestrationParentSubject: null | string
  Parent orchestration subject
- sourceEvent: ArvoEvent<Record<string, any>, Record<string,
      | null
      | string
      | number
      | boolean>, string>
  Original triggering event
- initEventId: string
  The id of the event which initiated the orchestration in the first place
- _domain: null | string
  The domain of the event.
Returns ArvoEvent<Record<string, any>, Record<string,
    | null
    | string
    | number
    | boolean>, string>
Throws
On schema/contract mismatch

Throws
On invalid parentSubject$$ format
- Defined in src/ArvoOrchestrator/index.ts:117

execute

execute(event, opentelemetry?): Promise<{
    events: ArvoEvent<Record<string, any>, Record<string,
        | null
        | string
        | number
        | boolean>, string>[];
}>
Core orchestration method that executes state machines in response to events.
Parameters
- event: ArvoEvent<Record<string, any>, Record<string,
      | null
      | string
      | number
      | boolean>, string>
  Event triggering the execution
- opentelemetry: ArvoEventHandlerOpenTelemetryOptions = ...
  OpenTelemetry configuration
Returns Promise<{
    events: ArvoEvent<Record<string, any>, Record<string,
        | null
        | string
        | number
        | boolean>, string>[];
}>
Object containing domained events

Throws
Lock/state operations failed

Throws
Invalid event structure/flow

Throws
Schema/contract mismatch

Throws
Missing/invalid machine version
Overrides AbstractArvoEventHandler.execute
- Defined in src/ArvoOrchestrator/index.ts:284

Class ArvoOrchestrator

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ArvoOrchestrator

Throws

Properties

ReadonlyexecutionEngine

Readonlyexecutionunits

Readonlyregistry

ReadonlysyncEventResource

Optional ReadonlysystemErrorDomain

Accessors

domain

Returns null | string

memory

Returns IMachineMemory<MachineMemoryRecord>

requiresResourceLocking

Returns boolean

source

Returns any

systemErrorSchema

Returns ArvoContractRecord

Methods

ProtectedcreateEmittableEvent

Parameters

Returns ArvoEvent<Record<string, any>, Record<string, | null | string | number | boolean>, string>

Throws

Throws

execute

Parameters

Returns Promise<{ events: ArvoEvent<Record<string, any>, Record<string, | null | string | number | boolean>, string>[]; }>

Throws

Throws

Throws

Throws

Settings

On This Page

`Readonly`executionEngine

`Readonly`executionunits

`Readonly`registry

`Readonly`syncEventResource

`Optional` `Readonly`systemErrorDomain

`Protected`createEmittableEvent

Returns ArvoEvent<Record<string, any>, Record<string,
| null
| string
| number
| boolean>, string>

Returns Promise<{
events: ArvoEvent<Record<string, any>, Record<string,
| null
| string
| number
| boolean>, string>[];
}>