All Packages  This Package  Class Hierarchy  Class Search  Index

java.lang.Object
   |
   +----edu.utah.janos.ants.ants.Capsule
           |
           +----edu.utah.janos.ants.ants.MIDIDRequestCapsule

Summary

final class  MIDIDRequestCapsule
     extends edu.utah.janos.ants.ants.Capsule
{
          // Fields 4
     static final byte[] MID;
     private static final byte[] PID;
     public static final String VERSION;
     private TypeID unknownMID;

          // Constructors 2
     MIDIDRequestCapsule();
     MIDIDRequestCapsule(TypeID);

          // Methods 6
     public Xdr decode();
     public Xdr encode();
     public boolean evaluate(Node);
     public int length();
     protected byte[] mid();
     protected byte[] pid();
}

MID ID Request capsule.

The MIDIDRequestCapsule adds one field to the base Capsule:

• the typeid of the unknown MID (this.unknownMID)

Pat said to make a note that this capsule could be a flow control message for data packets. It says, "woah, stop sending data until the code is loaded". But we don't take advantage of this yet.

See Also: DLProtocol, MIDIDResponseCapsule

Fields

· VERSION

Summary  |  Top

   public static final String VERSION

   static final byte[] MID

   private static final byte[] PID

   private TypeID unknownMID

The TypeID of the unknown MID this Capsule represents. This is set only by the constructor (for outgoing MIDIDRequestCapsules) or by the decode() function (for incoming MIDIDRequestCapsules).

Constructors

· MIDIDRequestCapsule

Summary  |  Top

   MIDIDRequestCapsule() 

Create a blank MIDIDRequestCapsule.

This constructor should only be invoked when a MIDIDRequestCapsule is being received and decoded.

   MIDIDRequestCapsule(TypeID unknownMID) 

Create a MIDIDRequestCapsule that will request info on the given unknown MID.

This constructor is only invoked by DLProtocolHandler. // XXX which is being renamed.

   protected byte[] mid() 

Overrides:

mid in class Capsule

   protected byte[] pid() 

Overrides:

pid in class Capsule

   public int length() 

Overrides:

length in class Capsule

   public Xdr encode() 

Overrides:

encode in class Capsule

   public Xdr decode() 

Overrides:

decode in class Capsule

   public boolean evaluate(Node node) 

Evaluate a MIDIDRequestCapsule. Based on the unknownMID stored in this capsule, lookup the CapsuleClass on the local node. If the CapsuleClass is not available drop the request on the floor. Otherwise, send a MIDIDResponseCapsule with the Protocol identity of the MID.

If the MIDIDRequestCapsule is for a builtin type, just drop the request.

Overrides:

evaluate in class Capsule

See Also: CodeGroup

All Packages  This Package  Class Hierarchy  Class Search  Index