contrib/psg/src/peersim/cdsim/CDProtocol.java

   1 /*
   2  * Copyright (c) 2003-2005 The BISON Project
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU Lesser General Public License version 2 as
   6  * published by the Free Software Foundation.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU Lesser General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU Lesser General Public License
  14  * along with this program; if not, write to the Free Software
  15  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  16  *
  17  */
  18
  19 package peersim.cdsim;
  20
  21 import peersim.core.Protocol;
  22 import peersim.core.Node;
  23
  24 /**
  25 * Defines cycle driven protocols, that is, protocols that have a periodic
  26 * activity in regular time intervals.
  27 */
  28 public interface CDProtocol extends Protocol
  29 {
  30
  31 /**
  32  * A protocol which is defined by performing an algorithm in more or less
  33  * regular periodic intervals.
  34  * This method is called by the simulator engine once in each cycle with
  35  * the appropriate parameters.
  36  *
  37  * @param node
  38  *          the node on which this component is run
  39  * @param protocolID
  40  *          the id of this protocol in the protocol array
  41  */
  42 public void nextCycle(Node node, int protocolID);
  43
  44 }