Source: impl/interest-filter-table.js

  1. /**
  2.  * Copyright (C) 2016-2018 Regents of the University of California.
  3.  * @author: Jeff Thompson <jefft0@remap.ucla.edu>
  4.  *
  5.  * This program is free software: you can redistribute it and/or modify
  6.  * it under the terms of the GNU Lesser General Public License as published by
  7.  * the Free Software Foundation, either version 3 of the License, or
  8.  * (at your option) any later version.
  9.  *
  10.  * This program is distributed in the hope that it will be useful,
  11.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13.  * GNU Lesser General Public License for more details.
  14.  *
  15.  * You should have received a copy of the GNU Lesser General Public License
  16.  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17.  * A copy of the GNU Lesser General Public License is in the file COPYING.
  18.  */
  20. /** @ignore */
  21. var LOG = require('../log.js').Log.LOG;
  23. /**
  24.  * An InterestFilterTable is an internal class to hold a list of entries with
  25.  * an interest Filter and its OnInterestCallback.
  26.  * @constructor
  27.  */
  28. var InterestFilterTable = function InterestFilterTable()
  29. {
  30.   this.table_ = []; // of Entry
  31. };
  33. exports.InterestFilterTable = InterestFilterTable;
  35. /**
  36.  * InterestFilterTable.Entry holds an interestFilterId, an InterestFilter and
  37.  * the OnInterestCallback with its related Face.
  38.  * Create a new Entry with the given values.
  39.  * @param {number} interestFilterId The ID from getNextEntryId().
  40.  * @param {InterestFilter} filter The InterestFilter for this entry.
  41.  * @param {function} onInterest The callback to call.
  42.  * @param {Face} face The face on which was called registerPrefix or
  43.  * setInterestFilter which is passed to the onInterest callback.
  44.  * @constructor
  45.  */
  46. InterestFilterTable.Entry = function InterestFilterTableEntry
  47.   (interestFilterId, filter, onInterest, face)
  48. {
  49.   this.interestFilterId_ = interestFilterId;
  50.   this.filter_ = filter;
  51.   this.onInterest_ = onInterest;
  52.   this.face_ = face;
  53. };
  55. /**
  56.  * Get the interestFilterId given to the constructor.
  57.  * @return {number} The interestFilterId.
  58.  */
  59. InterestFilterTable.Entry.prototype.getInterestFilterId = function()
  60. {
  61.   return this.interestFilterId_;
  62. };
  64. /**
  65.  * Get the InterestFilter given to the constructor.
  66.  * @return {InterestFilter} The InterestFilter.
  67.  */
  68. InterestFilterTable.Entry.prototype.getFilter = function()
  69. {
  70.   return this.filter_;
  71. };
  73. /**
  74.  * Get the onInterest callback given to the constructor.
  75.  * @return {function} The onInterest callback.
  76.  */
  77. InterestFilterTable.Entry.prototype.getOnInterest = function()
  78. {
  79.   return this.onInterest_;
  80. };
  82. /**
  83.  * Get the Face given to the constructor.
  84.  * @return {Face} The Face.
  85.  */
  86. InterestFilterTable.Entry.prototype.getFace = function()
  87. {
  88.   return this.face_;
  89. };
  91. /**
  92.  * Add a new entry to the table.
  93.  * @param {number} interestFilterId The ID from Node.getNextEntryId().
  94.  * @param {InterestFilter} filter The InterestFilter for this entry.
  95.  * @param {function} onInterest The callback to call.
  96.  * @param {Face} face The face on which was called registerPrefix or
  97.  * setInterestFilter which is passed to the onInterest callback.
  98.  */
  99. InterestFilterTable.prototype.setInterestFilter = function
  100.   (interestFilterId, filter, onInterest, face)
  101. {
  102.   this.table_.push(new InterestFilterTable.Entry
  103.     (interestFilterId, filter, onInterest, face));
  104. };
  106. /**
  107.  * Find all entries from the interest filter table where the interest conforms
  108.  * to the entry's filter, and add to the matchedFilters list.
  109.  * @param {Interest} interest The interest which may match the filter in
  110.  * multiple entries.
  111.  * @param {Array<InterestFilterTable.Entry>} matchedFilters Add each matching
  112.  * InterestFilterTable.Entry from the interest filter table.  The caller should
  113.  * pass in an empty array.
  114.  */
  115. InterestFilterTable.prototype.getMatchedFilters = function
  116.   (interest, matchedFilters)
  117. {
  118.   for (var i = 0; i < this.table_.length; ++i) {
  119.     var entry = this.table_[i];
  120.     if (entry.getFilter().doesMatch(interest.getName()))
  121.       matchedFilters.push(entry);
  122.   }
  123. };
  125. /**
  126.  * Remove the interest filter entry which has the interestFilterId from the
  127.  * interest filter table. This does not affect another interest filter with a
  128.  * different interestFilterId, even if it has the same prefix name. If there is
  129.  * no entry with the interestFilterId, do nothing.
  130.  * @param {number} interestFilterId The ID returned from setInterestFilter.
  131.  */
  132. InterestFilterTable.prototype.unsetInterestFilter = function(interestFilterId)
  133. {
  134.   // Go backwards through the list so we can erase entries.
  135.   // Remove all entries even though interestFilterId should be unique.
  136.   var count = 0;
  137.   for (var i = this.table_.length - 1; i >= 0; --i) {
  138.     if (this.table_[i].getInterestFilterId() == interestFilterId) {
  139.       ++count;
  140.       this.table_.splice(i, 1);
  141.     }
  142.   }
  144.   if (count === 0)
  145.     if (LOG > 0) console.log
  146.       ("unsetInterestFilter: Didn't find interestFilterId " + interestFilterId);
  147. };