zerorpc/lib/buffer.js

A port of ZeroRPC to node.js

// Open Source Initiative OSI - The MIT License (MIT):Licensing
//
// The MIT License (MIT)
// Copyright (c) 2015 François-Xavier Bourlet (bombela+zerorpc@gmail.com)
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the "Software"),
// to deal in the Software without restriction, including without limitation
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
// and/or sell copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.

//Creates a new channel buffer
//capacity : number
//      The capacity of the buffer
function ChannelBuffer(capacity) {
    //Pre-allocate the buffer array to its capacity and set the length to 0.
    //This way, the length property is correct, but the array size equals
    //the maximum buffer size, so it doesn't have to be resized (as much).
    this._buffer = new Array(capacity);
    this._buffer.length = 0;
    this._capacity = capacity;
}

//Adds an item to the buffer
ChannelBuffer.prototype.add = function(item) {
    this._buffer.push(item);
};

//Removes an item from the buffer
ChannelBuffer.prototype.remove = function() {
    return this._buffer.shift();
}

//Gets the number of items in the buffer
ChannelBuffer.prototype.length = function() {
    return this._buffer.length;
};

//Gets the channel capacity
ChannelBuffer.prototype.getCapacity = function() {
    return this._capacity;
}

//Checks whether the buffer has capacity
ChannelBuffer.prototype.hasCapacity = function() {
    return this._capacity > 0;
};

//Updates the capacity
ChannelBuffer.prototype.setCapacity = function(capacity) {
    this._capacity = capacity;
};

//Decrements the capacity
ChannelBuffer.prototype.decrementCapacity = function() {
    this._capacity--;
};

exports.ChannelBuffer = ChannelBuffer;