@freemework/common/src/cancellation/f_cancellation_token_aggregated.ts

Common library of the Freemework Project.

import { FException, FExceptionAggregate } from "../exception/index.js";
import { FCancellationException } from "./f_cancellation_exception.js";

import { FCancellationToken, FCancellationTokenCallback } from "./f_cancellation_token.js";

/**
 * Wrap several tokens as FCancellationToken
 */
export class FCancellationTokenAggregated implements FCancellationToken {
	private readonly _innerTokens: Array<FCancellationToken>;
	private readonly _cancelListeners: Array<FCancellationTokenCallback> = [];

	private _isCancellationRequested: boolean;

	public constructor(...tokens: Array<FCancellationToken>) {
		this._innerTokens = tokens;
		this._isCancellationRequested = false;

		const listener = (cancellationEx: FCancellationException) => {
			for (const innerToken of tokens) {
				innerToken.removeCancelListener(listener);
			}
			this._isCancellationRequested = true;
			const errors: Array<FException> = [];
			if (this._cancelListeners.length > 0) {
				// Release callback. We do not need its anymore
				const cancelListeners = this._cancelListeners.splice(0);
				cancelListeners.forEach(cancelListener => {
					try {
						cancelListener(cancellationEx);
					} catch (e) {
						errors.push(FException.wrapIfNeeded(e));
					}
				});
			}
			if (errors.length > 0) {
				throw new FExceptionAggregate(errors);
			}
		};
		for (const innerToken of tokens) {
			innerToken.addCancelListener(listener);
		}
	}

	/**
	 * Returns `true` if any of inner tokens requested cancellation
	 */
	public get isCancellationRequested(): boolean {
		return this._isCancellationRequested;
	}

	public addCancelListener(cb: FCancellationTokenCallback): void {
		this._cancelListeners.push(cb);
	}

	public removeCancelListener(cb: FCancellationTokenCallback): void {
		const cbIndex = this._cancelListeners.indexOf(cb);
		if (cbIndex !== -1) {
			this._cancelListeners.splice(cbIndex, 1);
		}
	}

	public throwIfCancellationRequested(): void {
		for (const innerToken of this._innerTokens) {
			innerToken.throwIfCancellationRequested();
		}
	}
}