Interface CancellationSenderStrategy

interface CancellationSenderStrategy {
    cleanup(id: CancellationId): void;
    dispose(): void;
    enableCancellation(request: RequestMessage): void;
    sendCancellation(
        conn: MessageConnection,
        id: CancellationId,
    ): Promise<void>;
}

Implemented by

Methods

cleanup dispose? enableCancellation? sendCancellation

Methods

cleanup

  • cleanup(id: CancellationId): void

  • Cleanup any cancellation state for the given cancellation id. After this method has been call no cancellation will be sent anymore for the given id.

    Parameters

    Returns void

Optionaldispose

  • dispose(): void

  • An optional method to dispose the strategy.

    Returns void

OptionalenableCancellation

  • enableCancellation(request: RequestMessage): void

  • Hook to enable cancellation for the given request.

    Parameters

    Returns void

sendCancellation

  • sendCancellation(conn: MessageConnection, id: CancellationId): Promise<void>

  • Send cancellation for the given cancellation id

    Parameters

    Returns Promise<void>

Settings

Member Visibility

On This Page

Methods