Source: externs/shaka/abortable.js

  1. /**
  2.  * @license
  3.  * Copyright 2016 Google Inc.
  4.  *
  5.  * Licensed under the Apache License, Version 2.0 (the "License");
  6.  * you may not use this file except in compliance with the License.
  7.  * You may obtain a copy of the License at
  8.  *
  9.  *     http://www.apache.org/licenses/LICENSE-2.0
  10.  *
  11.  * Unless required by applicable law or agreed to in writing, software
  12.  * distributed under the License is distributed on an "AS IS" BASIS,
  13.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14.  * See the License for the specific language governing permissions and
  15.  * limitations under the License.
  16.  */
  19. /** @externs */
  22. /**
  23.  * A representation of an abortable operation.  Note that these are not
  24.  * cancelable.  Cancelation implies undoing what has been done so far,
  25.  * whereas aborting only means that futher work is stopped.
  26.  *
  27.  * @interface
  28.  * @template T
  29.  * @exportDoc
  30.  */
  31. shakaExtern.IAbortableOperation;
  34. /**
  35.  * A Promise which represents the underlying operation.  It is resolved when
  36.  * the operation is complete, and rejected if the operation fails or is
  37.  * aborted.  Aborted operations should be rejected with a shaka.util.Error
  38.  * object using the error code OPERATION_ABORTED.
  39.  *
  40.  * @const {!Promise.<T>}
  41.  * @exportDoc
  42.  */
  43. shakaExtern.IAbortableOperation.prototype.promise;
  46. /**
  47.  * Can be called by anyone holding this object to abort the underlying
  48.  * operation.  This is not cancelation, and will not necessarily result in
  49.  * any work being undone.  abort() should return a Promise which is resolved
  50.  * when the underlying operation has been aborted.  The returned Promise
  51.  * should never be rejected.
  52.  *
  53.  * @return {!Promise}
  54.  * @exportDoc
  55.  */
  56. shakaExtern.IAbortableOperation.prototype.abort = function() {};
  59. /**
  60.  * @param {function(boolean)} onFinal A callback to be invoked after the
  61.  *   operation succeeds or fails.  The boolean argument is true if the operation
  62.  *   succeeded and false if it failed.
  63.  * @return {!shakaExtern.IAbortableOperation.<T>} Returns this.
  64.  * @exportDoc
  65.  */
  66. shakaExtern.IAbortableOperation.prototype.finally = function(onFinal) {};