Source: main/webapp/modules/IntegerPool.js

  1. /*
  2.  * Licensed to the Apache Software Foundation (ASF) under one
  3.  * or more contributor license agreements.  See the NOTICE file
  4.  * distributed with this work for additional information
  5.  * regarding copyright ownership.  The ASF licenses this file
  6.  * to you under the Apache License, Version 2.0 (the
  7.  * "License"); you may not use this file except in compliance
  8.  * with the License.  You may obtain a copy of the License at
  9.  *
  10.  *   http://www.apache.org/licenses/LICENSE-2.0
  11.  *
  12.  * Unless required by applicable law or agreed to in writing,
  13.  * software distributed under the License is distributed on an
  14.  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  15.  * KIND, either express or implied.  See the License for the
  16.  * specific language governing permissions and limitations
  17.  * under the License.
  18.  */
  20. var Guacamole = Guacamole || {};
  22. /**
  23.  * Integer pool which returns consistently increasing integers while integers
  24.  * are in use, and previously-used integers when possible.
  25.  * @constructor 
  26.  */
  27. Guacamole.IntegerPool = function() {
  29.     /**
  30.      * Reference to this integer pool.
  31.      *
  32.      * @private
  33.      */
  34.     var guac_pool = this;
  36.     /**
  37.      * Array of available integers.
  38.      *
  39.      * @private
  40.      * @type {!number[]}
  41.      */
  42.     var pool = [];
  44.     /**
  45.      * The next integer to return if no more integers remain.
  46.      *
  47.      * @type {!number}
  48.      */
  49.     this.next_int = 0;
  51.     /**
  52.      * Returns the next available integer in the pool. If possible, a previously
  53.      * used integer will be returned.
  54.      * 
  55.      * @return {!number}
  56.      *     The next available integer.
  57.      */
  58.     this.next = function() {
  60.         // If free'd integers exist, return one of those
  61.         if (pool.length > 0)
  62.             return pool.shift();
  64.         // Otherwise, return a new integer
  65.         return guac_pool.next_int++;
  67.     };
  69.     /**
  70.      * Frees the given integer, allowing it to be reused.
  71.      * 
  72.      * @param {!number} integer
  73.      *     The integer to free.
  74.      */
  75.     this.free = function(integer) {
  76.         pool.push(integer);
  77.     };
  79. };