Interface FSMHandler

Defines a handler that can register an FSM to receive notifications about changes in the state of the FSM.

interface FSMHandler {
    fsmCancels?(): void;
    fsmError?(err): void;
    fsmStarts?(): void;
    fsmStops?(): void;
    fsmUpdates?(): void;
    preFsmStart?(): void;
    preFsmStop?(): void;
    preFsmUpdate?(): void;
}

Methods

fsmCancels? fsmError? fsmStarts? fsmStops? fsmUpdates? preFsmStart? preFsmStop? preFsmUpdate?

Methods

Optional fsmCancels

Optional fsmError

Optional fsmStarts

  • fsmStarts(): void

  • When the FSM starts.

    Returns void

    Throws

    CancelFSMException If the FSM must be cancelled.

Optional fsmStops

  • fsmStops(): void

  • When the FSM enters a terminal state.

    Returns void

    Throws

    CancelFSMException If the FSM must be cancelled.

Optional fsmUpdates

  • fsmUpdates(): void

  • When the FSM runs to new state.

    Returns void

    Throws

    CancelFSMException If the FSM must be cancelled.

Optional preFsmStart

Optional preFsmStop

Optional preFsmUpdate

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc