All Packages  This Package  Class Hierarchy  Class Search  Index

java.lang.Object
   |
   +----edu.utah.janos.antsr.core.Capsule
           |
           +----edu.utah.janos.antsr.core.DataCapsule

Summary

public class  DataCapsule
     extends edu.utah.janos.antsr.core.Capsule
{
          // Fields 6
     private static final byte[] MID;
     private static final byte[] PID;
     public static final String VERSION;
     private ByteArray data;
     public short dpt;
     public short spt;

          // Constructors 2
     public DataCapsule();
     public DataCapsule(short, short, int, ByteArray);

          // Methods 9
     public Xdr decode();
     public Xdr encode();
     public boolean evaluate(Node);
     public ByteArray getData();
     public int length();
     protected byte[] mid();
     protected byte[] pid();
     public void setData(ByteArray);
     public String toString();
}

Data capsule. Data capsules simply forward themselves to their destination. Each DataCapsule contains source and destination application ports (in addition to the source and destination node addresses kept by the superclass). Also, an arbitrary ByteArray payload is attached to the capsule.

XXX This doesn't need to be a builtin capsule type. Its convenient and all, but its not critical. Move it out to the apps/ directory. (Well, the fact that its builtin means the ID is fixed, so this is handy in a backwards-compatiblity way.)

Author:

David Wetherall

Cross Reference

Extended By:

PingCapsule, PongCapsule, StatsReturnCapsule

   public static final String VERSION

WARNING: this is a builtin capsule, whose version number must be manually kept in synch with its functionality.

See Also: addCapsule

   private static final byte[] MID

   private static final byte[] PID

   public short spt

Source application's port.

Not used by the DataCapsule, but its assumed that most users of this type will want to know where the capsule came from.

   public short dpt

Destination application's port.

   private ByteArray data

Data payload this capsule pulls through the network.

Constructors

· DataCapsule

Summary  |  Top

   public DataCapsule() 

   public DataCapsule(short s, 
                      short d, 
                      int n, 
                      ByteArray p) 

Construct a new DataCapsule.

Parameter	Description
s	the source application's port
d	the destination application's port
n	the address of the destination node.
p	the payload.

   protected byte[] mid() 

Overrides:

mid in class Capsule

   protected byte[] pid() 

Overrides:

pid in class Capsule

   public int length() 

Return length of this data capsule.

Overrides:

length in class Capsule

See Also: Capsule.length

   public Xdr encode() 

Overrides:

encode in class Capsule

   public Xdr decode() 

Overrides:

decode in class Capsule

   public ByteArray getData() 

Get the payload associated with this DataCapsule.

   public void setData(ByteArray data) 

Set the payload associated with this DataCapsule.

   public boolean evaluate(Node n) 

Forwarding function for DataCapsules. Forwards the capsule to the appropriate application port if the capsule is on its destination node, otherwise forwards the capsule on to its destination node.

Overrides:

evaluate in class Capsule

   public String toString() 

Overrides:

toString in class Capsule

All Packages  This Package  Class Hierarchy  Class Search  Index