contrib/psg/src/peersim/transport/RouterInfo.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.transport;
  20
  21 /**
  22  * Generic interface to be implemented by protocols that need to be assigned to
  23  * routers. The idea is that each node is assigned to a router, by
  24  * invoking {@link #setRouter(int)} method. Routers are identified by
  25  * integer indexes (starting from 0), based on the assumption that the
  26  * router network
  27  * is static. The router information is then used by different
  28  * implementations to compute latency, congestion, etc.
  29  *
  30  * @author Alberto Montresor
  31  * @version $Revision: 1.4 $
  32  */
  33 public interface RouterInfo
  34 {
  35
  36 /**
  37  * Associates the node hosting this transport protocol instance with
  38  * a router in the router network.
  39  *
  40  * @param router the numeric index of the router
  41  */
  42 public void setRouter(int router);
  43
  44 /**
  45  * @return the router associated to this transport protocol.
  46  */
  47 public int getRouter();
  48
  49 }