contrib/psg/src/peersim/transport/Transport.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 import peersim.core.*;
  22
  23
  24 /**
  25  * This interface represents a generic transport protocol, used to
  26  * send messages through the underlying network. Generally, transport
  27  * protocols use {@link peersim.edsim.EDSimulator} to schedule the delivery of
  28  * messages with some appropriate delay. They can also model message omission
  29  * failure as well.
  30  *
  31  * @author Alberto Montresor
  32  * @version $Revision: 1.7 $
  33  */
  34 public interface Transport extends Protocol
  35 {
  36
  37 /**
  38  * Sends message <code>msg</code>       from node <code>src</code> to protocol
  39  * <code>pid</code> of node <code>dst</code>.
  40  *
  41  * @param src sender node
  42  * @param dest destination node
  43  * @param msg message to be sent
  44  * @param pid protocol identifier
  45  */
  46 public void send(Node src, Node dest, Object msg, int pid);
  47
  48
  49 /**
  50  * Return a latency estimate from node <code>src</code> to protocol
  51  * <code>pid</code> of node <code>dst</code>.
  52  *
  53  * @param src sender node
  54  * @param dest destination node
  55  */
  56 public long getLatency(Node src, Node dest);
  57
  58
  59 }