Files
shaka-player/lib/util/destroyer.js
T
Joey Parrish f539147d48 fix: Correct license headers in compiled output
This fixes all the license headers in the main library, which corrects
the appearance of the main license in the compiled output.

It seems that the `!` in the header forces the compiler to keep it in
the output.  I believe older compiler releases did this purely based
on `@license`.

Issue #2638

Change-Id: I7f0e918caad10c9af689c9d07672b7fe9be7b2f3
2020-06-09 16:05:09 -07:00

94 lines
2.2 KiB
JavaScript

/*! @license
* Shaka Player
* Copyright 2016 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
goog.provide('shaka.util.Destroyer');
goog.require('shaka.util.PublicPromise');
/**
* @summary
* A utility class to help work with |shaka.util.IDestroyable| objects.
*
* @final
*/
shaka.util.Destroyer = class {
/**
* @param {function():!Promise} callback
* A callback to destroy an object. This callback will only be called once
* regardless of how many times |destroy| is called.
*/
constructor(callback) {
/** @private {boolean} */
this.destroyed_ = false;
/** @private {!shaka.util.PublicPromise} */
this.waitOnDestroy_ = new shaka.util.PublicPromise();
/** @private {function():!Promise} */
this.onDestroy_ = callback;
}
/**
* Check if |destroy| has been called. This returning |true| does not mean
* that the promise returned by |destroy| has resolved yet.
*
* @return {boolean}
* @final
*/
destroyed() {
return this.destroyed_;
}
/**
* Request that the destroy callback be called. Will return a promise that
* will resolve once the callback terminates. The promise will never be
* rejected.
*
* @return {!Promise}
* @final
*/
destroy() {
if (this.destroyed_) {
return this.waitOnDestroy_;
}
// We have started destroying this object, so we should never get here
// again.
this.destroyed_ = true;
return this.onDestroy_().then(
() => { this.waitOnDestroy_.resolve(); },
() => { this.waitOnDestroy_.resolve(); });
}
/**
* Checks if the object is destroyed and throws an error if it is.
* @param {*=} error The inner error, if any.
*/
ensureNotDestroyed(error) {
if (this.destroyed_) {
if (error instanceof shaka.util.Error &&
error.code == shaka.util.Error.Code.OBJECT_DESTROYED) {
throw error;
}
throw shaka.util.Destroyer.destroyedError(error);
}
}
/**
* @param {*=} error The inner error, if any.
* @return {!shaka.util.Error}
*/
static destroyedError(error) {
return new shaka.util.Error(
shaka.util.Error.Severity.CRITICAL,
shaka.util.Error.Category.PLAYER,
shaka.util.Error.Code.OBJECT_DESTROYED,
error);
}
};