comb
comb.collections.Pool Public

Base class for a pool.

Instance Properties
PropertyTypeDefault ValueDescription
countNumber

the total number of objects in the pool, including free and in use objects.

freeCountNumber

the number of free objects in this pool.

inUseCountNumber

the number of objects in use in this pool.

maxObjectsNumber1

the maximum number of objects this pool should contain

minObjectsNumber0

the minimum number of objects this pool should contain.

Constructor

Defined collections/Pool.js

createObject Function Public

Defined collections/Pool.js

Creates a new object for this pool.

Returns Source 
  1. function (){
  2.    return {};
  3.            
  4. }
  5.

getObject Function Public

Defined collections/Pool.js

Retrieves an object from this pool. `

Returns Source 
  1. function (){
  2.    var ret;
  3.    if (this.count <= this.__maxObjects && this.freeCount > 0) {
  4.        ret = this.__freeObjects.dequeue();
  5.        this.__inUseObjects.push(ret);
  6.    } else if (this.count < this.__maxObjects) {
  7.        ret = this.createObject();
  8.        this.__inUseObjects.push(ret);
  9.    }
  10.    return ret;
  11.            
  12. }
  13.

removeObject Function Public

Defined collections/Pool.js

Removes an object from the pool, this can be overriden to provide any teardown of objects that needs to take place.

Arguments Returns Source 
  1. function (obj){
  2.    var index;
  3.    if (this.__freeObjects.contains(obj)) {
  4.        this.__freeObjects.remove(obj);
  5.    } else if ((index = this.__inUseObjects.indexOf(obj)) > -1) {
  6.        this.__inUseObjects.splice(index, 1);
  7.    }
  8.    //otherwise its not contained in this pool;
  9.    return obj;
  10.            
  11. }
  12.

returnObject Function Public

Defined collections/Pool.js

Returns an object to this pool. The object is validated before it is returned to the pool, if the validation fails then it is removed from the pool;

Arguments Source 
  1. function (obj){
  2.    var index;
  3.    if (this.validate(obj) && this.count <= this.__maxObjects && (index = this.__inUseObjects.indexOf(obj)) > -1) {
  4.        this.__freeObjects.enqueue(obj);
  5.        this.__inUseObjects.splice(index, 1);
  6.    } else {
  7.        this.removeObject(obj);
  8.    }
  9.            
  10. }
  11.

validate Function Public

Defined collections/Pool.js

Validates an object in this pool.
THIS SHOULD BE OVERRIDDEN TO VALIDATE

Arguments Source 
  1. function (obj){
  2.    return true;
  3.            
  4. }
  5.

License

MIT https://github.com/C2FO/comb/raw/master/LICENSE

Meta